Inspect

Create artifact

Create a published artifact. If the canonical URL already exists, returns the existing artifact unchanged.

Base URL
POST
/api/public/v1/artifacts

Create a published artifact. If the canonical URL already exists, returns the existing artifact unchanged.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key authentication. Use your API key as the bearer token.

Request Body

application/json
  1. body

Metadata must match the artifact kind: file requires uploadId, fileName and mimeType; session_replay requires inspectSessionId, replayId, replay and markers. url is always taken from the top-level field.

title*Artifacts.ArtifactTitle
Length1 <= length <= 200
url*Artifacts.ArtifactUrl

HTTP(S) URL without credentials or local/private host literals. Stored in WHATWG-canonical form.

Formaturi
Lengthlength <= 2048
description*Artifacts.ArtifactDescription
Length10 <= length <= 2000
kind*Artifacts.ArtifactKind
Value in"link""doc""ticket""message""channel""dashboard""pdf""design""feature_flag""file""session_replay"
metadata?
Default{}

Response Body

Artifact already existed for the provided URL

application/json
  1. response
data*
meta*
Example Request
curl -X POST 'https://your-org.inspect.com/api/public/v1/artifacts' \  -H 'Content-Type: application/json' \  -d '{  "title": "string",  "url": "http://example.com",  "description": "stringstri",  "kind": "link"}'
Example Response
{  "data": {    "id": "string",    "title": "string",    "url": "http://example.com",    "description": "string",    "kind": "link",    "metadata": {},    "created_at": "2019-08-24T14:15:22Z"  },  "meta": {    "created": true,    "duplicate_url": true  }}