CreateArtifact

curl --request POST \
  --url https://api.siftstack.com/api/v1/artifacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "storageClass": "ARTIFACT_STORAGE_CLASS_UNSPECIFIED",
  "createdVia": "ARTIFACT_CREATED_VIA_UNSPECIFIED",
  "payload": {},
  "links": [
    {
      "relation": "ARTIFACT_LINK_RELATION_UNSPECIFIED",
      "entityType": "ARTIFACT_ENTITY_TYPE_UNSPECIFIED",
      "entityId": "<string>"
    }
  ],
  "metadata": [
    {
      "key": {
        "name": "<string>",
        "type": "METADATA_KEY_TYPE_UNSPECIFIED",
        "archivedDate": "2023-11-07T05:31:56Z",
        "isArchived": true
      },
      "stringValue": "<string>",
      "numberValue": 123,
      "booleanValue": true,
      "archivedDate": "2023-11-07T05:31:56Z",
      "isArchived": true
    }
  ]
}
'

import requests

url = "https://api.siftstack.com/api/v1/artifacts"

payload = {
    "conversationId": "<string>",
    "title": "<string>",
    "summary": "<string>",
    "storageClass": "ARTIFACT_STORAGE_CLASS_UNSPECIFIED",
    "createdVia": "ARTIFACT_CREATED_VIA_UNSPECIFIED",
    "payload": {},
    "links": [
        {
            "relation": "ARTIFACT_LINK_RELATION_UNSPECIFIED",
            "entityType": "ARTIFACT_ENTITY_TYPE_UNSPECIFIED",
            "entityId": "<string>"
        }
    ],
    "metadata": [
        {
            "key": {
                "name": "<string>",
                "type": "METADATA_KEY_TYPE_UNSPECIFIED",
                "archivedDate": "2023-11-07T05:31:56Z",
                "isArchived": True
            },
            "stringValue": "<string>",
            "numberValue": 123,
            "booleanValue": True,
            "archivedDate": "2023-11-07T05:31:56Z",
            "isArchived": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.siftstack.com/api/v1/artifacts"

	payload := strings.NewReader("{\n  \"conversationId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"summary\": \"<string>\",\n  \"storageClass\": \"ARTIFACT_STORAGE_CLASS_UNSPECIFIED\",\n  \"createdVia\": \"ARTIFACT_CREATED_VIA_UNSPECIFIED\",\n  \"payload\": {},\n  \"links\": [\n    {\n      \"relation\": \"ARTIFACT_LINK_RELATION_UNSPECIFIED\",\n      \"entityType\": \"ARTIFACT_ENTITY_TYPE_UNSPECIFIED\",\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"key\": {\n        \"name\": \"<string>\",\n        \"type\": \"METADATA_KEY_TYPE_UNSPECIFIED\",\n        \"archivedDate\": \"2023-11-07T05:31:56Z\",\n        \"isArchived\": true\n      },\n      \"stringValue\": \"<string>\",\n      \"numberValue\": 123,\n      \"booleanValue\": true,\n      \"archivedDate\": \"2023-11-07T05:31:56Z\",\n      \"isArchived\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "artifact": {
    "artifact": {
      "artifactId": "<string>",
      "organizationId": "<string>",
      "createdByUserId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "archivedDate": "2023-11-07T05:31:56Z",
      "storageClass": "ARTIFACT_STORAGE_CLASS_UNSPECIFIED",
      "createdVia": "ARTIFACT_CREATED_VIA_UNSPECIFIED",
      "currentVersionId": "<string>"
    },
    "artifactVersion": {
      "artifactVersionId": "<string>",
      "artifactId": "<string>",
      "version": 123,
      "title": "<string>",
      "summary": "<string>",
      "authoringMessageId": "<string>",
      "sourceToolUseIds": [
        "<string>"
      ],
      "remoteFileId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "fileName": "<string>",
      "fileMimeType": "<string>",
      "payload": {},
      "metadata": [
        {
          "key": {
            "name": "<string>",
            "type": "METADATA_KEY_TYPE_UNSPECIFIED",
            "archivedDate": "2023-11-07T05:31:56Z",
            "isArchived": true
          },
          "stringValue": "<string>",
          "numberValue": 123,
          "booleanValue": true,
          "relationValue": {
            "resourceType": "<string>",
            "resourceId": "<string>"
          },
          "archivedDate": "2023-11-07T05:31:56Z",
          "isArchived": true
        }
      ]
    }
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

api

artifacts

CreateArtifact

curl --request POST \
  --url https://api.siftstack.com/api/v1/artifacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "storageClass": "ARTIFACT_STORAGE_CLASS_UNSPECIFIED",
  "createdVia": "ARTIFACT_CREATED_VIA_UNSPECIFIED",
  "payload": {},
  "links": [
    {
      "relation": "ARTIFACT_LINK_RELATION_UNSPECIFIED",
      "entityType": "ARTIFACT_ENTITY_TYPE_UNSPECIFIED",
      "entityId": "<string>"
    }
  ],
  "metadata": [
    {
      "key": {
        "name": "<string>",
        "type": "METADATA_KEY_TYPE_UNSPECIFIED",
        "archivedDate": "2023-11-07T05:31:56Z",
        "isArchived": true
      },
      "stringValue": "<string>",
      "numberValue": 123,
      "booleanValue": true,
      "archivedDate": "2023-11-07T05:31:56Z",
      "isArchived": true
    }
  ]
}
'

import requests

url = "https://api.siftstack.com/api/v1/artifacts"

payload = {
    "conversationId": "<string>",
    "title": "<string>",
    "summary": "<string>",
    "storageClass": "ARTIFACT_STORAGE_CLASS_UNSPECIFIED",
    "createdVia": "ARTIFACT_CREATED_VIA_UNSPECIFIED",
    "payload": {},
    "links": [
        {
            "relation": "ARTIFACT_LINK_RELATION_UNSPECIFIED",
            "entityType": "ARTIFACT_ENTITY_TYPE_UNSPECIFIED",
            "entityId": "<string>"
        }
    ],
    "metadata": [
        {
            "key": {
                "name": "<string>",
                "type": "METADATA_KEY_TYPE_UNSPECIFIED",
                "archivedDate": "2023-11-07T05:31:56Z",
                "isArchived": True
            },
            "stringValue": "<string>",
            "numberValue": 123,
            "booleanValue": True,
            "archivedDate": "2023-11-07T05:31:56Z",
            "isArchived": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.siftstack.com/api/v1/artifacts"

	payload := strings.NewReader("{\n  \"conversationId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"summary\": \"<string>\",\n  \"storageClass\": \"ARTIFACT_STORAGE_CLASS_UNSPECIFIED\",\n  \"createdVia\": \"ARTIFACT_CREATED_VIA_UNSPECIFIED\",\n  \"payload\": {},\n  \"links\": [\n    {\n      \"relation\": \"ARTIFACT_LINK_RELATION_UNSPECIFIED\",\n      \"entityType\": \"ARTIFACT_ENTITY_TYPE_UNSPECIFIED\",\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"key\": {\n        \"name\": \"<string>\",\n        \"type\": \"METADATA_KEY_TYPE_UNSPECIFIED\",\n        \"archivedDate\": \"2023-11-07T05:31:56Z\",\n        \"isArchived\": true\n      },\n      \"stringValue\": \"<string>\",\n      \"numberValue\": 123,\n      \"booleanValue\": true,\n      \"archivedDate\": \"2023-11-07T05:31:56Z\",\n      \"isArchived\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "artifact": {
    "artifact": {
      "artifactId": "<string>",
      "organizationId": "<string>",
      "createdByUserId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "archivedDate": "2023-11-07T05:31:56Z",
      "storageClass": "ARTIFACT_STORAGE_CLASS_UNSPECIFIED",
      "createdVia": "ARTIFACT_CREATED_VIA_UNSPECIFIED",
      "currentVersionId": "<string>"
    },
    "artifactVersion": {
      "artifactVersionId": "<string>",
      "artifactId": "<string>",
      "version": 123,
      "title": "<string>",
      "summary": "<string>",
      "authoringMessageId": "<string>",
      "sourceToolUseIds": [
        "<string>"
      ],
      "remoteFileId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "fileName": "<string>",
      "fileMimeType": "<string>",
      "payload": {},
      "metadata": [
        {
          "key": {
            "name": "<string>",
            "type": "METADATA_KEY_TYPE_UNSPECIFIED",
            "archivedDate": "2023-11-07T05:31:56Z",
            "isArchived": true
          },
          "stringValue": "<string>",
          "numberValue": 123,
          "booleanValue": true,
          "relationValue": {
            "resourceType": "<string>",
            "resourceId": "<string>"
          },
          "archivedDate": "2023-11-07T05:31:56Z",
          "isArchived": true
        }
      ]
    }
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

conversationId

string

Set to link the new artifact to a conversation at create time. Legal only for the conversation's author. Equivalent to a links entry with relation ATTACHED_TO, entity_type CONVERSATION, and this conversation_id as entity_id.

title

string

summary

string

storageClass

enum<string>

default:ARTIFACT_STORAGE_CLASS_UNSPECIFIED

ARTIFACT_STORAGE_CLASS_UNSPECIFIED: The storage class is not specified.
ARTIFACT_STORAGE_CLASS_FILE: Bytes in remote_files, previewable by MIME type.
ARTIFACT_STORAGE_CLASS_STRUCTURED: Content is the JSON payload, no file.
ARTIFACT_STORAGE_CLASS_BLOB: Bytes in remote_files, opaque, download only.

Available options:

ARTIFACT_STORAGE_CLASS_UNSPECIFIED,

ARTIFACT_STORAGE_CLASS_FILE,

ARTIFACT_STORAGE_CLASS_STRUCTURED,

ARTIFACT_STORAGE_CLASS_BLOB

createdVia

enum<string>

default:ARTIFACT_CREATED_VIA_UNSPECIFIED

Which surface wrote the artifact.

ARTIFACT_CREATED_VIA_UNSPECIFIED: The producing surface is not specified.
ARTIFACT_CREATED_VIA_AGENT: An agent wrote the artifact.
ARTIFACT_CREATED_VIA_CANVAS: Canvas wrote the artifact.
ARTIFACT_CREATED_VIA_UPLOAD: A direct upload wrote the artifact.

Available options:

ARTIFACT_CREATED_VIA_UNSPECIFIED,

ARTIFACT_CREATED_VIA_AGENT,

ARTIFACT_CREATED_VIA_CANVAS,

ARTIFACT_CREATED_VIA_UPLOAD

payload

object

Required for STRUCTURED and rejected otherwise. The serialized payload must not exceed 1 MiB.

links

object[]

Links written at version 1.

Show child attributes

metadata

object[]

Metadata attached to the created version.

Show child attributes

Response

A successful response.

artifact

object

An artifact and one of its versions: the one artifact_version_id pinned, or the latest.

Show child attributes

Authenticate

Clients

Review

Export

Attachments

Reference

CreateArtifact

Authorizations

Body

Response