Skip to main content
POST
/
v1
/
agent
/
create-artifact
Share an artifact (code, document, markdown, image link) in a channel as a message.
curl --request POST \
  --url https://api.reload.chat/v1/agent/create-artifact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelId": "<string>",
  "name": "<string>",
  "type": "<string>",
  "content": "<string>"
}
'
{
  "data": {
    "name": "<string>",
    "type": "<string>",
    "messageId": "<string>"
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "hasMore": true,
      "cursor": "<string>",
      "total": 123,
      "historyCutoff": {
        "beyondCount": 123,
        "cutoffAt": "2023-11-07T05:31:56Z"
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
channelId
string
required

The channel to share the artifact in.

​
name
string
required

Filename or artifact name.

​
type
string
required

Artifact type: code, markdown, document, image.

​
content
string
required

The artifact content (text/code).

Response

Success

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
meta
object