Skip to main content
POST
Register an artifact

Authorizations

Authorization
string
header
required

OrgX API key, sent as Authorization: Bearer oxk_...

Headers

Idempotency-Key
string
required

Workspace-scoped retry key for safe mutation replay.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$

Body

application/json

One of artifact_url or external_url is required.

entity_type
enum<string>
required
Available options:
project,
initiative,
workstream,
milestone,
task,
decision
entity_id
string<uuid>
required
name
string
required
Required string length: 1 - 500
artifact_type
string
required
Required string length: 1 - 120
artifact_url
string
Maximum string length: 2000
external_url
string
Maximum string length: 2000
description
string | null
Maximum string length: 4000
preview_markdown
string
Maximum string length: 25000
initiative_id
string<uuid>
status
enum<string>
Available options:
draft,
in_review,
changes_requested,
superseded,
archived
metadata
object
created_by_type
enum<string>
Available options:
human,
agent
created_by_id
string<uuid>

Response

The artifact returned for a safe replay with the same Idempotency-Key

data
object
required

A registered piece of produced work attached to a workspace entity.

meta
object
required