Export Session Artifact

POST/v1/openai-agents/sessions/{session-id}/artifacts/export

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

session-id (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`session-id`	path	`string`	Yes

Request Body

JSON request bodies are capped at 2 MiB.

Property	Type	Required	Description
`path`	`string`	Yes

Responses

201 Success

Property	Type	Description
`object_id`	`string`
`filename`	`string`
`content_type`	`string`
`size_bytes`	`integer`
`sha256`	`string`
`kind`	`string`
`created_at`	`string`

400 Invalid request

Property	Type	Description
`error`	`object`

403 Permission denied

Property	Type	Description
`error`	`object`

404 Not found

Property	Type	Description
`error`	`object`

500 Internal error

Property	Type	Description
`error`	`object`

503 Unavailable

Property	Type	Description
`error`	`object`

Request

curl -X POST "http://localhost:8089/v1/openai-agents/sessions/{session-id}/artifacts/export" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"string"}'

const response = await fetch("http://localhost:8089/v1/openai-agents/sessions/{session-id}/artifacts/export", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "path": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/openai-agents/sessions/{session-id}/artifacts/export",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "path": "string"
},
)
data = response.json()

Response

{
  "object_id": "string",
  "filename": "string",
  "content_type": "string",
  "size_bytes": 0,
  "sha256": "string",
  "kind": "string",
  "created_at": "string"
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}