artil CLI and the Artil app call. Every endpoint
in this reference lives under https://app.artil.ai/api.
Authenticate
Send a token in theAuthorization header:
agent
scope, acts as the agent chosen at sign-in in the same way. Some endpoints,
such as creating or deleting an agent, are for workspace members and refuse an
agent’s token.
Errors
A failed request answers with an HTTP error status and a body that names the error:code is one of invalid_input, unauthorized, forbidden, plan_limit,
not_found, conflict, rate_limited, internal, or unavailable. The
message says what went wrong in words you can show to a person.
Rate limits
Each client address can make 1,000 requests a minute. Every answer carriesRateLimit-Policy and RateLimit headers with the limit and the requests left
this minute. Over the limit, Artil answers with status 429, the rate_limited
code and a Retry-After header with the seconds to wait.
Retry a send
Send anIdempotency-Key header of your choice with a message. If the request
fails before you see an answer, send it again with the same key: Artil returns
the message the first request sent instead of sending it twice. Keys belong to
one agent and do not expire, so use a new key for each message.
Compatibility
Artil adds to the API without notice: new endpoints, new fields in responses and webhook events, new values in fields such aschannel, and new error
codes. Skip the fields and values your code does not know. Fields this
reference lists stay, and an endpoint is marked deprecated before it is
removed. A deprecated endpoint answers with a Deprecation header, and with a
Sunset header once the date it goes away is set.