AgentSkyAPI reference
One origin, one namespace
Everything lives under https://api.agentsky.dev/v1 with a Bearer token. Management is request/response; conversation is a 202 send plus one standing SSE stream.
The reference below is rendered from the machine-readable spec — the same schemas the routes validate with: https://api.agentsky.dev/v1/openapi.json.
Authentication
Every request sends Authorization: Bearer ast_…. Tokens are minted in Developer → API keys or by sky auth login — never by other tokens. Scopes are ordered read ⊂ write ⊂ admin; a token is personal (acts as you everywhere) or scoped to one universe. Pass X-Universe: <slug> to act inside a non-personal universe.
Errors
Every non-2xx body is { "error": { "code", "message" } }:
| HTTP | code | When |
|---|---|---|
| 400 | invalid_request | malformed JSON / validation failure |
| 400 | invalid_memory | invalid memory operation or memory limit reached |
| 401 | invalid_token | missing, unknown, revoked, or expired token |
| 402 | insufficient_credits | the spend gate blocked the turn |
| 403 | insufficient_scope · universe_mismatch · forbidden | scope too low; X-Universe conflicts with a scoped token; agent has no API binding |
| 403 | personal_memory_only | caller or universe is not eligible for personal memory |
| 404 | not_found | unknown agent/universe (also masks unauthorized ids) |
| 409 | conflict | version conflict |
| 409 | memory_conflict | memory changed; read the current version before writing |
| 422 | invalid_spec | valid JSON, invalid domain rules (e.g. llm not allowed for type) |
| 429 | rate_limited | 100,000 requests/min per token exceeded — honor Retry-After |
Billing
/billingreadRead credit balance and card availability
Returns the caller's credit balance and whether a card is on file. No card details are returned.
balance_usdrequiredcard_on_filerequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/billing' \
-H "Authorization: Bearer ast_..."/billing/card-setupwriteStart saving a payment card
Returns a hosted card form URL to open in a browser. Saving the card does not charge it; auto top-up can charge it when a later session starts below the configured threshold. No request body is required.
urlrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/billing/card-setup \
-H "Authorization: Bearer ast_..."Credit campaigns
/credit-campaignsadminList live and recent credit campaigns
Campaign result
campaignsrequiredInvalid request
Authentication required
Admin token scope and administrator allowlist membership required
Unknown campaign
Campaign migrations required
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/credit-campaigns' \
-H "Authorization: Bearer ast_..."/credit-campaignsadminIssue a public credit link or personal email invitations
Only allowlisted administrators can use these operations. Use one UUID requestId per campaign and reuse the identical body after timeouts. Personal emails are deduplicated and each gets a distinct, email-bound single-use code. Existing verified, unbanned recipients are credited immediately. sendEmail explicitly authorizes product email. Code creation is atomic; delivery/credit failures are per recipient. Retry the same request for retry_needed credit results; never change requestId just to retry. Email status sent means SES accepted, not inbox delivery. Sending/uncertain attempts are not automatically resent; use the returned personal link for manual delivery. Responses contain bearer codes: keep private. A different body with the same requestId returns 409.
requestIdrequiredpattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
amountUsdrequiredexpiresInDaysrequirednoterequiredmax length 200
audiencerequired▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
kindrequiredslotsrequiredoption 2▸ Show child attributes▾ Hide child attributes
kindrequiredemailsrequiredpattern ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
sendEmaildefault: false
Campaign result
campaignIdrequiredrecipientsrequired▸ Show child attributes▾ Hide child attributes
idrequiredemailrequiredcoderequiredurlrequiredclaimrequiredemailStatusrequirednotifiedAtrequiredInvalid request
Authentication required
Admin token scope and administrator allowlist membership required
Unknown campaign
requestId reused with different settings
Content-Type must be application/json
Campaign migrations required
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/credit-campaigns \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"requestId":"40a9ae2a-4ea5-4a50-987e-d8b3c99c96f0","amountUsd":20,"expiresInDays":30,"note":"Launch invitations","audience":{"kind":"recipients","emails":["recipient@example.com"]},"sendEmail":true}'Read claim, email and recipient usage results
Returns grantedUsd, claimed, activeRecipients, agentUsageUsd and individual link states. Usage is agent/runtime ledger spend since first claim, excludes API gateway and is not attribution to the gifted credit pool.
idrequiredCampaign result
campaignIdrequirednoterequiredamountUsdrequiredmaxRedemptionsrequiredclaimedrequiredgrantedUsdrequiredactiveRecipientsrequiredagentUsageUsdrequiredusageBasisrequiredlinksrequired▸ Show child attributes▾ Hide child attributes
idrequiredemailrequiredstaterequired"active" · "disabled" · "expired" · "exhausted"
claimedrequiredemailStatusrequiredexpiresAtrequirednotifiedAtrequiredurlrequiredInvalid request
Authentication required
Admin token scope and administrator allowlist membership required
Unknown campaign
Campaign migrations required
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/credit-campaigns/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."Disable all unclaimed campaign codes
Already granted credit stays in recipients' accounts.
idrequiredCampaign result
disabledrequiredInvalid request
Authentication required
Admin token scope and administrator allowlist membership required
Unknown campaign
Campaign migrations required
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/credit-campaigns/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Memory stores
/memory_storesreadList memory stores
include_archivedafterlimitList of memory stores
memory_storesrequired▸ Show child attributes▾ Hide child attributes
idrequiredmemstore_…
objectrequired"memory_store"
namerequireddescriptionrequiredattach_by_defaultrequired"none" · "read_only"
created_atrequiredupdated_atrequiredarchived_atrequiredhas_morerequirednext_cursorOpaque cursor; pass as `after` on the next request.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/memory_stores' \
-H "Authorization: Bearer ast_..."/memory_storeswriteCreate a memory store
namerequiredmax length 255
descriptionmax length 4096
attach_by_default"none" · "read_only"
Created memory store
memory_storerequired▸ Show child attributes▾ Hide child attributes
idrequiredmemstore_…
objectrequired"memory_store"
namerequireddescriptionrequiredattach_by_defaultrequired"none" · "read_only"
created_atrequiredupdated_atrequiredarchived_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/memory_stores \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"name":"team-notes","description":"Shared team knowledge base"}'Get a memory store
store_idrequiredThe memory store id (memstore_…)
Memory store
memory_storerequired▸ Show child attributes▾ Hide child attributes
idrequiredmemstore_…
objectrequired"memory_store"
namerequireddescriptionrequiredattach_by_defaultrequired"none" · "read_only"
created_atrequiredupdated_atrequiredarchived_atrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x' \
-H "Authorization: Bearer ast_..."Update a memory store
store_idrequiredThe memory store id (memstore_…)
namemax length 255
descriptionmax length 4096
attach_by_default"none" · "read_only"
Updated memory store
memory_storerequired▸ Show child attributes▾ Hide child attributes
idrequiredmemstore_…
objectrequired"memory_store"
namerequireddescriptionrequiredattach_by_defaultrequired"none" · "read_only"
created_atrequiredupdated_atrequiredarchived_atrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"name":"team-notes-v2","description":"Updated description"}'Delete a memory store
store_idrequiredThe memory store id (memstore_…)
Deleted
Error — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x \
-H "Authorization: Bearer ast_..."Archive a memory store (one-way, idempotent)
store_idrequiredThe memory store id (memstore_…)
Archived memory store
memory_storerequired▸ Show child attributes▾ Hide child attributes
idrequiredmemstore_…
objectrequired"memory_store"
namerequireddescriptionrequiredattach_by_defaultrequired"none" · "read_only"
created_atrequiredupdated_atrequiredarchived_atrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/archive \
-H "Authorization: Bearer ast_..."List memories in a store
store_idrequiredThe memory store id (memstore_…)
path_prefixMust end with / (default: /)
depthafterlimitList of memories
memoriesrequired▸ Show child attributes▾ Hide child attributes
option 1Memory without content — returned in list responses.
▸ Show child attributes▾ Hide child attributes
idrequiredmem_…
typerequiredDiscriminator for the memories list union. — "memory"
objectrequired"memory"
memory_store_idrequiredpathrequiredAbsolute path starting with /
content_sha256requiredcontent_bytesrequiredcreated_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"memory_prefix"
pathrequiredCommon path prefix ending with /
has_morerequirednext_cursorOpaque cursor; pass as `after` on the next request.
Error — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memories' \
-H "Authorization: Bearer ast_..."Create a memory
store_idrequiredThe memory store id (memstore_…)
pathrequiredAbsolute path starting with /
contentmax length 102400
Created memory
memoryrequiredMemory with content — returned by single-get, create, and update responses.
▸ Show child attributes▾ Hide child attributes
idrequiredmem_…
objectrequired"memory"
memory_store_idrequiredpathrequiredAbsolute path starting with /
contentrequiredcontent_sha256requiredcontent_bytesrequiredcreated_atrequiredupdated_atrequiredversion_idrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memories \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"path":"/notes/hello","content":"Hello, world"}'Get a memory with content
store_idrequiredThe memory store id (memstore_…)
memory_idrequiredThe memory id (mem_…)
Memory with content
memoryrequiredMemory with content — returned by single-get, create, and update responses.
▸ Show child attributes▾ Hide child attributes
idrequiredmem_…
objectrequired"memory"
memory_store_idrequiredpathrequiredAbsolute path starting with /
contentrequiredcontent_sha256requiredcontent_bytesrequiredcreated_atrequiredupdated_atrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memories/mem_cmtc5q1y' \
-H "Authorization: Bearer ast_..."Update a memory
store_idrequiredThe memory store id (memstore_…)
memory_idrequiredThe memory id (mem_…)
contentmax length 102400
pathRename the memory to this path
precondition▸ Show child attributes▾ Hide child attributes
typerequired"content_sha256"
content_sha256requiredUpdated memory
memoryrequiredMemory with content — returned by single-get, create, and update responses.
▸ Show child attributes▾ Hide child attributes
idrequiredmem_…
objectrequired"memory"
memory_store_idrequiredpathrequiredAbsolute path starting with /
contentrequiredcontent_sha256requiredcontent_bytesrequiredcreated_atrequiredupdated_atrequiredversion_idrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessageError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memories/mem_cmtc5q1y \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"content":"Hello, world v2","precondition":{"type":"content_sha256","content_sha256":"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"}}'Delete a memory
store_idrequiredThe memory store id (memstore_…)
memory_idrequiredThe memory id (mem_…)
Deleted
Error — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memories/mem_cmtc5q1y \
-H "Authorization: Bearer ast_..."List memory versions for a store
store_idrequiredThe memory store id (memstore_…)
memory_idFilter to a single memory
afterlimitList of memory versions
memory_versionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredmemver_…
objectrequired"memory_version"
memory_store_idrequiredmemory_idrequiredpathrequiredcontentrequirednull when redacted
content_sha256requiredoperationrequired"create" · "update" · "delete"
actor_typerequired"user" · "session"
actor_idrequiredredacted_atrequiredcreated_atrequiredhas_morerequirednext_cursorOpaque cursor; pass as `after` on the next request.
Error — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memory_versions' \
-H "Authorization: Bearer ast_..."Get a single memory version
store_idrequiredThe memory store id (memstore_…)
version_idrequiredThe memory version id (memver_…)
Memory version
memory_versionrequired▸ Show child attributes▾ Hide child attributes
idrequiredmemver_…
objectrequired"memory_version"
memory_store_idrequiredmemory_idrequiredpathrequiredcontentrequirednull when redacted
content_sha256requiredoperationrequired"create" · "update" · "delete"
actor_typerequired"user" · "session"
actor_idrequiredredacted_atrequiredcreated_atrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memory_versions/memver_cmtc5q1z' \
-H "Authorization: Bearer ast_..."Redact the content of a memory version
store_idrequiredThe memory store id (memstore_…)
version_idrequiredThe memory version id (memver_…)
Redacted memory version
memory_versionrequired▸ Show child attributes▾ Hide child attributes
idrequiredmemver_…
objectrequired"memory_version"
memory_store_idrequiredmemory_idrequiredpathrequiredcontentrequirednull when redacted
content_sha256requiredoperationrequired"create" · "update" · "delete"
actor_typerequired"user" · "session"
actor_idrequiredredacted_atrequiredcreated_atrequiredError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessageError — { error: { code, message } }
error▸ Show child attributes▾ Hide child attributes
codemessage{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/memory_stores/memstore_cmtc5q1x/memory_versions/memver_cmtc5q1z/redact \
-H "Authorization: Bearer ast_..."Memory
/memoryreadRead your personal cross-session memory
Requires read scope. Only unrestricted owner-facing credentials in the authenticated owner's personal universe are supported; restricted tokens, delegated callers, and team universes return 403.
Saved entries and the opaque version required for the next write.
entriesrequired▸ Show child attributes▾ Hide child attributes
indexrequiredtextrequiredversionrequiredAuthentication required
insufficient_scope or personal_memory_only: caller or universe is not eligible
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/memory' \
-H "Authorization: Bearer ast_..."/memorywriteSave, edit, remove or clear a personal memory
Requires write scope and unrestricted owner-facing credentials in your personal universe. Read GET /memory first and copy its version exactly into expectedVersion, even when entries is empty. The sample uses null for a store before its first write; replace it with the returned version for an existing document. Stale writes return 409; reload and resolve the change instead of overwriting. Entries are limited to 2048 UTF-8 bytes and the complete recall context to 4000 characters. A state-changing clear advances the version; a no-op on an existing document retains it. Clear preserves allocated indexes.
option 1▸ Show child attributes▾ Hide child attributes
oprequiredtextrequiredmax length 8192
expectedVersionrequiredmax length 128
option 2▸ Show child attributes▾ Hide child attributes
oprequiredindexrequiredtextrequiredmax length 8192
expectedVersionrequiredmax length 128
option 3▸ Show child attributes▾ Hide child attributes
oprequiredindexrequiredexpectedVersionrequiredmax length 128
option 4▸ Show child attributes▾ Hide child attributes
oprequiredexpectedVersionrequiredmax length 128
Saved entries and the opaque version required for the next write.
entriesrequired▸ Show child attributes▾ Hide child attributes
indexrequiredtextrequiredversionrequiredinvalid_memory: invalid operation or memory limit reached
Authentication required
insufficient_scope or personal_memory_only: caller or universe is not eligible
memory_conflict: reload before writing
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/memory \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"op":"save","text":"Use Celsius for temperatures.","expectedVersion":null}'/context/searchreadSearch saved memory or personal conversations
Searches one platform-owned source in your personal universe. Restricted and delegated callers are refused. The consumer app separately aggregates imports and artifacts; they are not platform data. Results are literal matches in stable source order, not a global relevance ranking. Follow nextCursor until null and inspect partial/coverage before concluding no match exists. Memory entries have no per-entry timestamps, so their coverage reports that time filtering does not apply.
qrequiredscoperequiredlimitcursorSource continuation returned by this query.
sinceInclusive lower time bound.
untilExclusive upper time bound; must follow since.
A bounded source page, with continuation and coverage.
hitsrequired▸ Show child attributes▾ Hide child attributes
hitrequired▸ Show child attributes▾ Hide child attributes
sourcerequired"memory" · "sessions" · "imports" · "artifacts"
idrequiredtitlerequiredsnippetrequiredoccurredAtrefrequired▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
kindrequiredindexrequiredversionrequiredoption 2▸ Show child attributes▾ Hide child attributes
kindrequiredsessionIdrequiredmax length 200
messageIdrequiredmax length 200
option 3▸ Show child attributes▾ Hide child attributes
kindrequiredtraceIdrequiredmax length 200
seqrequiredoption 4▸ Show child attributes▾ Hide child attributes
kindrequiredartifactIdrequiredmax length 200
versionrequiredcitationcursorrequiredmax length 4096
nextCursorrequiredmax length 4096
coveragerequiredpartialInvalid query, source reference, cursor or text offset
Authentication required
The caller lacks personal-context authority or read scope
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/context/search?q=concise&scope=memory' \
-H "Authorization: Bearer ast_..."/context/readreadRead a saved memory or conversation reference
Rechecks personal ownership and deletion. Accepts memory and session_message references from search. Memory returns the current entry and flags version changes; it does not preserve old versions. Message reads return bounded text and adjacent references for surrounding context. Use nextOffset for a long main message; follow adjacent refs to continue reading. All text together is bounded to 20,000 characters per page.
refrequiredURL-encoded JSON source reference copied from a search hit.
offsetCurrent reference, text, nextOffset, truncated, updated, adjacent references and coverage.
reftextnextOffsettruncatedupdatedcoverageadjacent▸ Show child attributes▾ Hide child attributes
reftexttruncatedInvalid query, source reference, cursor or text offset
Authentication required
The caller lacks personal-context authority or read scope
Source unavailable or not owned by this caller
Memory changed while paging; read again from offset zero
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/context/read?ref=%7B%22kind%22%3A%22memory%22%2C%22index%22%3A0%2C%22version%22%3Anull%7D' \
-H "Authorization: Bearer ast_..."Identity
/whoamireadCaller identity, resolved universe, effective scopes
userrequired▸ Show child attributes▾ Hide child attributes
idemailnameuniverserequired▸ Show child attributes▾ Hide child attributes
slugnameisPersonalscopesrequired"read" · "write" · "admin"
authrequired"token" · "session"
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/whoami' \
-H "Authorization: Bearer ast_..."Universes
/universesreadList universes
universesrequired▸ Show child attributes▾ Hide child attributes
slugnameisPersonalThe workspace is its owner's default workspace
isDefaultThe workspace is the caller's own default workspace
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes' \
-H "Authorization: Bearer ast_..."/universeswrite, personal tokens onlyCreate a universe
slugrequiredmax length 40 — pattern ^[a-z0-9][a-z0-9-]*[a-z0-9]$
namemax length 80
universerequired▸ Show child attributes▾ Hide child attributes
slugnameisPersonalThe workspace is its owner's default workspace
isDefaultThe workspace is the caller's own default workspace
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"slug":"acme","name":"Acme"}'Universe detail
slugrequiredThe universe slug
universerequired▸ Show child attributes▾ Hide child attributes
slugnameisPersonalThe workspace is its owner's default workspace
isDefaultThe workspace is the caller's own default workspace
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme' \
-H "Authorization: Bearer ast_..."People in the workspace and, for owners and admins, waiting invitations
slugrequiredThe universe slug
rolerequired"owner" · "admin" · "member"
membersrequired▸ Show child attributes▾ Hide child attributes
user_idemailnamerole"owner" · "admin" · "member"
joined_atinvitesrequired▸ Show child attributes▾ Hide child attributes
idemailrole"admin" · "member"
invited_byexpires_atcreated_atlimit_requestsMembers' tasks that wait for a higher monthly limit, oldest first
▸ Show child attributes▾ Hide child attributes
idsession_idtitlemember▸ Show child attributes▾ Hide child attributes
user_idnameemailraise_to▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
heldMessages the task holds and will run when the limit is raised
created_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme/members' \
-H "Authorization: Bearer ast_..."Remove a non-owner from the workspace, or leave it
The owner removes anyone but themselves. Anyone else may name only themselves (their id, or me), which is how a person leaves; naming someone else is 403, and the owner cannot leave (400). Ends membership access, stops sharing every connection the person shared with the workspace, and closes pending and accepted invitation links. Accounts and threads remain; workspace-visible threads owned by the removed person become read-only for remaining members.
slugrequiredThe universe slug
userIdrequiredokrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/universes/acme/members/cmtb3u5r7k2p9x01s6q8n4w2 \
-H "Authorization: Bearer ast_..."/universes/{slug}/members/{userId}write, ownerMake someone an admin or a member
slugrequiredThe universe slug
userIdrequiredrolerequired"admin" · "member"
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/universes/acme/members/cmtb3u5r7k2p9x01s6q8n4w2 \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"role":"admin"}'/universes/{slug}/inviteswrite, owner or adminAdd people to the workspace by email
Set send_email to true to send invitation mail and include per-email delivery results. sent means provider acceptance; unavailable leaves a usable link to share. No email is sent and no delivery field is returned by default. The response carries one link token per new invitation (shown only here; links are /join/{token} on the consumer app). Each person joins through the link, or the next time they use AgentSky signed in with that verified email; an invitation lasts 30 days.
slugrequiredThe universe slug
emailsrequiredsend_emaildefault: false
role"admin" · "member" — default: "member"
inviteslinks▸ Show child attributes▾ Hide child attributes
emailtokendelivery▸ Show child attributes▾ Hide child attributes
emailstatus"sent" · "unavailable"
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/invites \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"emails":["teammate@acme.com"],"role":"member","send_email":true}'/universes/{slug}/invites/{inviteId}write, owner or adminWithdraw an invitation that has not been taken up
slugrequiredThe universe slug
inviteIdrequiredokrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/universes/acme/invites/cmtb4i7v2n6q8z01s6k3m5p1 \
-H "Authorization: Bearer ast_..."/universes/{slug}/walletread, owner or adminA workspace's own wallet: balance, each member's spending this month, limits, members waiting for a higher limit
404 where workspace wallets are not switched on for the workspace, 400 for a person's default workspace that has no wallet and nobody else in it, 403 for a plain member.
slugrequiredThe universe slug
walletrequiredNull until the workspace is given a wallet
month_startrequiredThe first instant (UTC) of the month the spending below is counted from
membersrequired▸ Show child attributes▾ Hide child attributes
user_idemailnamerole"owner" · "admin" · "member"
spent▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
monthly_limit▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
fundingrequiredThe latest additions to the wallet, newest first
▸ Show child attributes▾ Hide child attributes
idamount▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
added_bycreated_atlimit_requestsrequiredMembers' tasks that wait for a higher monthly limit, oldest first
▸ Show child attributes▾ Hide child attributes
idsession_idtitlemember▸ Show child attributes▾ Hide child attributes
user_idnameemailraise_to▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
heldMessages the task holds and will run when the limit is raised
created_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme/wallet' \
-H "Authorization: Bearer ast_..."/universes/{slug}/walletwrite, owner or adminGive the workspace a wallet of its own
From then on a new session a member starts in the workspace is paid from this wallet unless its request names payer personal. Sessions that already exist keep the payer recorded for them. Repeating the call returns the wallet that exists.
slugrequiredThe universe slug
walletrequiredNull until the workspace is given a wallet
month_startrequiredThe first instant (UTC) of the month the spending below is counted from
membersrequired▸ Show child attributes▾ Hide child attributes
user_idemailnamerole"owner" · "admin" · "member"
spent▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
monthly_limit▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
fundingrequiredThe latest additions to the wallet, newest first
▸ Show child attributes▾ Hide child attributes
idamount▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
added_bycreated_atlimit_requestsrequiredMembers' tasks that wait for a higher monthly limit, oldest first
▸ Show child attributes▾ Hide child attributes
idsession_idtitlemember▸ Show child attributes▾ Hide child attributes
user_idnameemailraise_to▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
heldMessages the task holds and will run when the limit is raised
created_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/wallet \
-H "Authorization: Bearer ast_..."/universes/{slug}/wallet/transferswrite, owner or adminMove some of your own purchased credit into the workspace wallet
All or nothing. Only credit the caller bought moves; free credit stays. 402 insufficient_purchased_credit when the caller holds less purchased credit than the amount, 409 workspace_wallet_missing before the wallet exists. request_id makes a repeat of the same request land once (200 instead of 201); the same id with another amount is 409 idempotency_conflict.
slugrequiredThe universe slug
amountrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
request_idrequiredmax length 100
Moved
transferredbalance▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/wallet/transfers \
-H "Authorization: Bearer ast_..."/universes/{slug}/wallet/topupswrite, owner or adminBuy credit for the workspace wallet with your own saved card
Charges the caller's own saved card the credit plus the card processing fee and adds the credit to the workspace wallet. The caller's own balance, card and auto top-up are not changed. amount is 1000, 2000, 5000 or 10000 cents. request_id makes a repeat of the same request charge once (200 instead of 201). 409 card_required when the caller has no saved card (add one to your own account first), 402 card_declined, 409 workspace_wallet_missing before the wallet exists, 503 payments_unavailable where card payments are not set up. A workspace key or a restricted credential cannot buy credit.
slugrequiredThe universe slug
amountrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
request_idrequiredmax length 100
Bought
chargedbalance▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/wallet/topups \
-H "Authorization: Bearer ast_..."/universes/{slug}/wallet/limit-requests/{requestId}write, owner or adminAnswer a member's request for a higher monthly limit
A member who reaches their monthly limit is not only refused: the task they started or wrote to waits, holding what it was given, and a request is raised (limit_requests on the wallet, and a spend request on the task). raise sets the member's limit to the amount the request offered and sends on what every waiting task of theirs was holding; decline closes this request and drops what its task held. 404 when the request is not open.
slugrequiredThe universe slug
requestIdrequiredanswerrequired"raise" · "decline"
okmessage_idThe first message sent on to a waiting task, when one was
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/wallet/limit-requests/requestId \
-H "Authorization: Bearer ast_..."/universes/{slug}/wallet/limits/{userId}write, owner or adminSet or clear a member's monthly limit on workspace wallet spending
The limit counts what the sessions that member started were charged to the workspace wallet in the calendar month (UTC), their helpers included. At the limit a message to a session the workspace pays for, a helper, a handoff and a fork are refused with 402 member_limit_reached, and a new session is created waiting; other members are not affected. monthly_limit null removes the limit. When the new limit lets the member spend again their waiting tasks continue by themselves: resumed counts the messages that were sent on.
slugrequiredThe universe slug
userIdrequiredmonthly_limitrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
okresumed{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/universes/acme/wallet/limits/cmtb3u5r7k2p9x01s6q8n4w2 \
-H "Authorization: Bearer ast_..."Connected apps people share with the workspace, and the ones it owns
sharing says whether members can share connected apps with this workspace; while it is on, can_connect says whether the caller may connect an app for the workspace itself, and a connection the workspace owns carries workspace_owned. A person's default workspace takes shared connections only once someone besides its owner is in it. Agents in the workspace's sessions can call through a shared connection whoever started the session; nobody but the person who shared it holds its sign-in.
slugrequiredThe universe slug
sharingrequiredWhether members can share connected apps with this workspace.
can_connectWhile sharing is on: whether the caller may connect an app for the workspace itself.
connectionsrequired▸ Show child attributes▾ Hide child attributes
connection_idappapp_namelabelshared_by▸ Show child attributes▾ Hide child attributes
user_idnameshared_atmineTrue when the caller is the person who shared it.
workspace_ownedPresent and true when the workspace itself owns the connection.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme/connections' \
-H "Authorization: Bearer ast_..."Share one of your own connections with the workspace, or start connecting an app for it
With connection_id: only a connection of the caller's can be shared; answers 201 with the workspace's connections. With app, success_url and error_url (owner or admin): starts connecting an app for the workspace itself and answers 200 with the address to open in a browser; record the result with POST /universes/{slug}/connections/complete. A connection made this way belongs to the workspace, not to the person who made it, and stays when they leave. Mail and calendar apps stay personal either way (400 personal_only).
slugrequiredThe universe slug
connection_idappsuccess_urlerror_urlStarted
urlsharingrequiredWhether members can share connected apps with this workspace.
can_connectWhile sharing is on: whether the caller may connect an app for the workspace itself.
connectionsrequired▸ Show child attributes▾ Hide child attributes
connection_idappapp_namelabelshared_by▸ Show child attributes▾ Hide child attributes
user_idnameshared_atmineTrue when the caller is the person who shared it.
workspace_ownedPresent and true when the workspace itself owns the connection.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/connections \
-H "Authorization: Bearer ast_..."/universes/{slug}/connections/completewrite, owner or adminRecord an app connected for the workspace itself
The account is checked against the workspace's own accounts at the provider; without account_id its newest one for the app is used. From then on agents in every session of the workspace can call through it. 404 when the workspace has no such account.
slugrequiredThe universe slug
apprequiredaccount_idsharingrequiredWhether members can share connected apps with this workspace.
can_connectWhile sharing is on: whether the caller may connect an app for the workspace itself.
connectionsrequired▸ Show child attributes▾ Hide child attributes
connection_idappapp_namelabelshared_by▸ Show child attributes▾ Hide child attributes
user_idnameshared_atmineTrue when the caller is the person who shared it.
workspace_ownedPresent and true when the workspace itself owns the connection.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/connections/complete \
-H "Authorization: Bearer ast_..."/universes/{slug}/connections/{connectionId}write, the sharer, owner or adminStop sharing a connection with the workspace
Agents lose it at once. A connection the workspace owns itself is disconnected for good, by an owner or admin only.
slugrequiredThe universe slug
connectionIdrequiredokrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/universes/acme/connections/connectionId \
-H "Authorization: Bearer ast_..."/universes/{slug}/keysread, owner or adminKeys that belong to the workspace
A workspace key belongs to the workspace, not to the person who made it, and keeps working after they leave. It acts through the workspace owner's account, whose wallet pays for the sessions it starts, and reaches only the workspace's agents, sessions, files, skills and environments. The listing never carries a secret.
slugrequiredThe universe slug
keysrequired▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredprefixrequiredThe start of the secret, to tell one key from another.
scopesrequired"read" · "write" · "admin"
created_byrequired▸ Show child attributes▾ Hide child attributes
user_idnamecreated_atrequiredlast_used_atexpires_atrevoked_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme/keys' \
-H "Authorization: Bearer ast_..."/universes/{slug}/keysadmin, owner or adminMake a workspace key
The secret is returned only in this response. The key carries no more scope than the credential that makes it.
slugrequiredThe universe slug
namerequiredmax length 80
scopesrequired"read" · "write" · "admin"
expires_atkeyrequired▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredprefixrequiredThe start of the secret, to tell one key from another.
scopesrequired"read" · "write" · "admin"
created_byrequired▸ Show child attributes▾ Hide child attributes
user_idnamecreated_atrequiredlast_used_atexpires_atrevoked_atsecretrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/keys \
-H "Authorization: Bearer ast_..."/universes/{slug}/keys/{keyId}admin, owner or adminRevoke a workspace key
slugrequiredThe universe slug
keyIdrequiredokrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/universes/acme/keys/keyId \
-H "Authorization: Bearer ast_..."Get workspace shared hooks
slugrequiredThe universe slug
hooks{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme/hooks' \
-H "Authorization: Bearer ast_..."Replace workspace shared hooks (owner only)
slugrequiredThe universe slug
hooksrequiredhooks{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/universes/acme/hooks \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"hooks":[{"event":"pre_tool_use","matcher":"Bash","command":"./.agentsky/check-command.sh","timeout_s":30}]}'List workspace policy rules
slugrequiredThe universe slug
rules▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme/policies' \
-H "Authorization: Bearer ast_..."Create a workspace policy rule (owner only)
A rule {name, kind: "CAPABILITY", config: {"platform.orchestration": "deny"}} stops every session of the workspace from bringing in other agents as helpers (403 hiring_disabled to the agent; helpers it already has can still be listed, collected and stopped), and sessions created afterwards are not told how to hire. Disable or delete the rule to turn hiring back on.
slugrequiredThe universe slug
option 1▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired▸ Show child attributes▾ Hide child attributes
actionrequired"allow" · "ask" · "deny"
matchermax length 255
commandPatternsmax length 500
option 2▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired▸ Show child attributes▾ Hide child attributes
warnUsdMicroshardCapUsdMicrosrequiredoption 3▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired▸ Show child attributes▾ Hide child attributes
limitPerSessionrequiredoption 4▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired"allow" · "ask" · "deny"
rule▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/universes/acme/policies \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"name":"Block destructive shell commands","kind":"TOOL_CALL","config":{"action":"deny","matcher":"Bash","commandPatterns":["rm -rf *"]}}'Get a workspace policy rule
slugrequiredThe universe slug
ruleIdrequiredThe policy rule id
rule▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/universes/acme/policies/cmtb5p0l3r8w2k01s6x7n9q4' \
-H "Authorization: Bearer ast_..."Update a workspace policy rule (owner only)
slugrequiredThe universe slug
ruleIdrequiredThe policy rule id
namemax length 128
enabledpositionconfig▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
actionrequired"allow" · "ask" · "deny"
matchermax length 255
commandPatternsmax length 500
option 2▸ Show child attributes▾ Hide child attributes
warnUsdMicroshardCapUsdMicrosrequiredoption 3▸ Show child attributes▾ Hide child attributes
limitPerSessionrequiredoption 4"allow" · "ask" · "deny"
rule▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/universes/acme/policies/cmtb5p0l3r8w2k01s6x7n9q4 \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"enabled":false}'Delete a workspace policy rule (owner only)
slugrequiredThe universe slug
ruleIdrequiredThe policy rule id
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/universes/acme/policies/cmtb5p0l3r8w2k01s6x7n9q4 \
-H "Authorization: Bearer ast_..."Products and Runs
/productsreadProducts, permitted inputs and configuration, prices and certified capabilities
Every agent in the catalog (GET /catalog/agents) is also listed, as `@handle`; it is available when its latest check run passed the required checks.
Executable product catalog
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/products' \
-H "Authorization: Bearer ast_..."/runswriteRun a product
String input is a shortcut. Agent objects preserve one user message and optional system message. Direct Agent Runs prepare a Session with platform billing; an existing Session retains its payer and billing settings. Non-streaming waits up to ten seconds. SSE begins with the durable Run identity. Disconnect never cancels execution. A catalog handle (`@handle`) runs that agent as one turn of a new session of it, charged as that session is: `addons` may set `model`, within the agent's engine, and `instructions`, files added after the agent's own, and nothing else; a `user.message` sent to the Run (POST /runs/{id}/events) is the next turn of that session and a Run of its own. When a Run of a handle ends, each webhook endpoint of the workspace subscribed to `run.completed`, `run.interrupted`, `run.failed` or `run.blocked` receives that event once, signed like every other webhook. A handle whose agent has not passed its checks is refused with `listing_not_checked` or `listing_checks_failed`.
productrequiredmax length 240
inputrequiredaddonssession_idstreammetadataDurable Run identity, status, output and references to authoritative billing.
run▸ Show child attributes▾ Hide child attributes
idrequiredproductrequiredsession_idrequiredstatusrequired"queued" · "running" · "waiting_input" · "stopping" · "completed" · "interrupted" · "failed" · "blocked" · "reconciling"
outputrequiredoutput_availableusagerequiredbillingrequirederrorrequiredartifact▸ Show child attributes▾ Hide child attributes
idrequiredmediaTyperequiredurlrequiredsource▸ Show child attributes▾ Hide child attributes
goal_iditerationroutine_run_idroutine_idcreated_atrequiredcompleted_atrequiredDurable Run identity, status, output and references to authoritative billing.
run▸ Show child attributes▾ Hide child attributes
idrequiredproductrequiredsession_idrequiredstatusrequired"queued" · "running" · "waiting_input" · "stopping" · "completed" · "interrupted" · "failed" · "blocked" · "reconciling"
outputrequiredoutput_availableusagerequiredbillingrequirederrorrequiredartifact▸ Show child attributes▾ Hide child attributes
idrequiredmediaTyperequiredurlrequiredsource▸ Show child attributes▾ Hide child attributes
goal_iditerationroutine_run_idroutine_idcreated_atrequiredcompleted_atrequiredSession busy or conflicting idempotency key
The product cannot be run: a listed agent that has not passed its checks, or an override that is not allowed
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/runs \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"product":"@claude_code","input":"Summarize the repository."}'/runs/{id}readRead a Run
idrequiredDurable Run identity, status, output and references to authoritative billing.
run▸ Show child attributes▾ Hide child attributes
idrequiredproductrequiredsession_idrequiredstatusrequired"queued" · "running" · "waiting_input" · "stopping" · "completed" · "interrupted" · "failed" · "blocked" · "reconciling"
outputrequiredoutput_availableusagerequiredbillingrequirederrorrequiredartifact▸ Show child attributes▾ Hide child attributes
idrequiredmediaTyperequiredurlrequiredsource▸ Show child attributes▾ Hide child attributes
goal_iditerationroutine_run_idroutine_idcreated_atrequiredcompleted_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/runs/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."Read durable Run events, or observe with Accept: text/event-stream
A Run of a catalog handle reports `run.running`, each `agent.message` with its text, and how it ended.
idrequiredcursorOpaque Run cursor, separate from the Session transcript cursor
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/runs/sess_cmtb7q2j/events' \
-H "Authorization: Bearer ast_..."/runs/{id}/eventswriteTarget steering or an interrupt to this Run
For a Run of a catalog handle, one `user.message` starts the next turn of the Run's session as a new Run and is answered with `{ run_id, status }` naming that new Run (also in `Location`); it follows the idempotency rules of starting a Run, and is refused with 409 `session_busy` while a turn of the session is still going and 409 `session_archived` once the session has ended. One `user.interrupt` stops this Run's turn and is answered with `{ run_id, status }` for this Run; a Run that has already ended is answered with the status it ended in. A system message is not accepted.
idrequiredeventsrequired▸ Show child attributes▾ Hide child attributes
type: "user.message"▸ Show child attributes▾ Hide child attributes
typerequiredcontentrequired▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "image"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtype: "document"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "text"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typedefault: "text/plain"
datarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtitlecontextinteraction_mode"plan" · "build"
type: "system.message"▸ Show child attributes▾ Hide child attributes
typerequiredcontentrequired▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "user.interrupt"▸ Show child attributes▾ Hide child attributes
typerequiredControl admitted; runtime confirmation is separate
Run is terminal or input conflicts
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/runs/sess_cmtb7q2j/events \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"events":[{"type":"user.interrupt"}]}'Agents
/agentsreadList agents in the resolved universe
agentsrequired▸ Show child attributes▾ Hide child attributes
idThe agent id (agent_…) — the only address
namedisplayNameagentTypeEngine — hermes · claude_code · codex · openclaw · pi · dsh · kimi_code · opencode · jev, or any ACP harness (the full vocabulary is the enum on CreateAgent)
llmharnessVersionThe engine CLI version this agent's sessions run; PATCH to move to the platform's current version
reasoningEffortHarness-native reasoning effort; null = model-compatible fallback for constrained models, otherwise harness default. Applies from the next provision/restart. Allowed values depend on agentType — agoragentic_acp: not supported; amp_acp: not supported; auggie: not supported; autohand: not supported; cline: not supported; codebuddy_code: not supported; cortex_code: not supported; corust_agent: not supported; crow_cli: not supported; cursor: not supported; deepagents: not supported; devin: not supported; dimcode: not supported; dirac: not supported; factory_droid: not supported; fast_agent: not supported; gemini: not supported; github_copilot_cli: not supported; glm_acp_agent: not supported; antigravity_acp: not supported; goose: not supported; grok_build: not supported; harn: not supported; junie: not supported; kilo: not supported; kimchi: not supported; minimax_code: not supported; minion_code: not supported; mistral_vibe: not supported; nova: not supported; poolside: not supported; qoder: not supported; qwen_code: not supported; sigit: not supported; stakpak: not supported; vtcode: not supported; code_assistant: not supported; docker_cagent: not supported; kiro: not supported; muse_code: not supported; openhands: not supported; hermes: none/minimal/low/medium/high/xhigh/max/ultra; claude_code: low/medium/high/xhigh/max; codex: none/minimal/low/medium/high/xhigh/max; openclaw: not supported; jev: not supported; pi: off/minimal/low/medium/high/xhigh/max; dsh: not supported; kimi_code: not supported; opencode: none/minimal/low/medium/high/xhigh/max; workspace_acp: not supported; models: claude-haiku-4-5: not supported; gemini-3.8-flash: low/medium/high; gemini-3.5-flash: low/medium/high; glm-5.3: low/high/max; glm-5.3-flash: low/high/max; grok-4.6: low/medium/high; grok-4.7: low/medium/high/xhigh; codex/hermes + gpt-6.1-sol: low/medium/high/xhigh/max — "none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra" · null
capabilitiesThe built-in capabilities this agent is granted — the exact set its sessions may execute (enforced; empty = none). Ids are listed at /docs/capabilities. — "embedding.openai" · "embedding.voyage" · "rerank.voyage" · "ocr.mistral" · "exa.search" · "exa.contents" · "tinyfish.fetch" · "tinyfish.browser" · "tinyfish.agent" · "dataforseo.serp" · "dataforseo.ai-keywords" · "dataforseo.llm-responses" · "dataforseo.app-info" · "dataforseo.app-search" · "dataforseo.backlinks" · "dataforseo.business-reviews" · "dataforseo.business-pinterest" · "dataforseo.content-analysis" · "dataforseo.technologies" · "dataforseo.keyword-data" · "dataforseo.labs" · "dataforseo.amazon" · "dataforseo.onpage" · "gptimage.generate" · "rembg.remove-background" · "seedance.generate" · "mm.i2v" · "wan.t2v" · "wan.i2v" · "happyhorse.t2v" · "minimax.h3" · "fish-audio.transcribe" · "code-review" · "exa.answer" · "googlemap.geocode" · "googlemap.places" · "agentmail.list-inboxes" · "tinyfish.search" · "tinyfish.profile-list" · "meta.transcribe" · "minimax.tts" · "elevenlabs.sound" · "zai.transcribe" · "openai.transcribe" · "fish-audio.tts" · "google.image" · "openai.image-2.5" · "wan.image" · "logo.lookup" · "openmeteo.weather" · "frankfurter.fx" · "dictionary.define" · "openlibrary.search" · "googledns.resolve" · "qrserver.create" · "social-boost.catalog"
versionBumped on every update; see expectedVersion
archivedsessionCountcreatedAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/agents' \
-H "Authorization: Bearer ast_..."/agentswriteCreate an agent
An agent is a reusable configuration — engine, prompt, capabilities, secrets. Every field is optional: an empty body creates the default pi agent with no built-in capabilities (capabilities are explicit opt-in; unknown ids → 400). The response's `id` (agent_…) is the agent's only address. One agent can run many sessions; creating the agent provisions nothing — session creation provisions the pod by default (POST /v1/sessions supports deferred provisioning). Optional Idempotency-Key safely replays the original 201 response within the same user and universe; changing the body with the same key returns 409 idempotency_conflict. Keys do not expire.
namePrompt label only — not an address. An agent is addressed by the `id` in the response (agent_…); names are free and need not be unique — max length 60
descriptionmax length 500
agentType"hermes" · "claude_code" · "codex" · "openclaw" · "pi" · "dsh" · "kimi_code" · "opencode" · "jev" · "agoragentic_acp" · "amp_acp" · "auggie" · "autohand" · "cline" · "codebuddy_code" · "cortex_code" · "corust_agent" · "crow_cli" · "cursor" · "deepagents" · "devin" · "dimcode" · "dirac" · "factory_droid" · "fast_agent" · "gemini" · "github_copilot_cli" · "glm_acp_agent" · "antigravity_acp" · "goose" · "grok_build" · "harn" · "junie" · "kilo" · "kimchi" · "minimax_code" · "minion_code" · "mistral_vibe" · "nova" · "poolside" · "qoder" · "qwen_code" · "sigit" · "stakpak" · "vtcode" · "code_assistant" · "docker_cagent" · "kiro" · "openhands" · "muse_code" · "workspace_acp"
llmreasoningEffortHarness/model-compatible reasoning effort; omitted = model-compatible fallback for constrained models, otherwise harness default. Explicit values must fit both agentType and llm — agoragentic_acp: not supported; amp_acp: not supported; auggie: not supported; autohand: not supported; cline: not supported; codebuddy_code: not supported; cortex_code: not supported; corust_agent: not supported; crow_cli: not supported; cursor: not supported; deepagents: not supported; devin: not supported; dimcode: not supported; dirac: not supported; factory_droid: not supported; fast_agent: not supported; gemini: not supported; github_copilot_cli: not supported; glm_acp_agent: not supported; antigravity_acp: not supported; goose: not supported; grok_build: not supported; harn: not supported; junie: not supported; kilo: not supported; kimchi: not supported; minimax_code: not supported; minion_code: not supported; mistral_vibe: not supported; nova: not supported; poolside: not supported; qoder: not supported; qwen_code: not supported; sigit: not supported; stakpak: not supported; vtcode: not supported; code_assistant: not supported; docker_cagent: not supported; kiro: not supported; muse_code: not supported; openhands: not supported; hermes: none/minimal/low/medium/high/xhigh/max/ultra; claude_code: low/medium/high/xhigh/max; codex: none/minimal/low/medium/high/xhigh/max; openclaw: not supported; jev: not supported; pi: off/minimal/low/medium/high/xhigh/max; dsh: not supported; kimi_code: not supported; opencode: none/minimal/low/medium/high/xhigh/max; workspace_acp: not supported; models: claude-haiku-4-5: not supported; gemini-3.8-flash: low/medium/high; gemini-3.5-flash: low/medium/high; glm-5.3: low/high/max; glm-5.3-flash: low/high/max; grok-4.6: low/medium/high; grok-4.7: low/medium/high/xhigh; codex/hermes + gpt-6.1-sol: low/medium/high/xhigh/max — "none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra"
promptmax length 100000
displayNameWhat the agent is called in the console and in channels; omitted = an auto-generated asteroid name — max length 60
capabilities"embedding.openai" · "embedding.voyage" · "rerank.voyage" · "ocr.mistral" · "exa.search" · "exa.contents" · "tinyfish.fetch" · "tinyfish.browser" · "tinyfish.agent" · "dataforseo.serp" · "dataforseo.ai-keywords" · "dataforseo.llm-responses" · "dataforseo.app-info" · "dataforseo.app-search" · "dataforseo.backlinks" · "dataforseo.business-reviews" · "dataforseo.business-pinterest" · "dataforseo.content-analysis" · "dataforseo.technologies" · "dataforseo.keyword-data" · "dataforseo.labs" · "dataforseo.amazon" · "dataforseo.onpage" · "gptimage.generate" · "rembg.remove-background" · "seedance.generate" · "mm.i2v" · "wan.t2v" · "wan.i2v" · "happyhorse.t2v" · "minimax.h3" · "fish-audio.transcribe" · "code-review" · "exa.answer" · "googlemap.geocode" · "googlemap.places" · "agentmail.list-inboxes" · "tinyfish.search" · "tinyfish.profile-list" · "meta.transcribe" · "minimax.tts" · "elevenlabs.sound" · "zai.transcribe" · "openai.transcribe" · "fish-audio.tts" · "google.image" · "openai.image-2.5" · "wan.image" · "logo.lookup" · "openmeteo.weather" · "frankfurter.fx" · "dictionary.define" · "openlibrary.search" · "googledns.resolve" · "qrserver.create" · "social-boost.catalog"
instructions▸ Show child attributes▾ Hide child attributes
namerequiredpattern .*\.md$
contentdefault: ""
skillsRFC-0073 skill attachments: store references ({type:'skill', skillId, version?: 'latest'|skr_…}) and GitHub shortcuts ({type:'github', url, ref?, tokenSecretRef?}). Max 20.
▸ Show child attributes▾ Hide child attributes
type: "skill"▸ Show child attributes▾ Hide child attributes
typerequiredskillIdrequiredversiondefault: "latest"
type: "github"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredrefBranch or commit SHA; default branch when omitted.
tokenSecretRefAgent secret key holding a clone token for private repos.
mcpServersRemote streamable-HTTP MCP servers this agent connects to.
▸ Show child attributes▾ Hide child attributes
typedefault: "url"
namerequiredmax length 255
urlrequiredtools▸ Show child attributes▾ Hide child attributes
includedefault: []
excludedefault: []
hooksShell commands run in the session's pod at lifecycle events ({event, command, matcher?, timeout_s?}). Every harness accepts every event; a hook can stop a prompt or a tool call only on a harness whose own hook system fires that event. Max 20.
▸ Show child attributes▾ Hide child attributes
eventrequired"pre_session_start" · "session_start" · "user_prompt_submit" · "pre_tool_use" · "post_tool_use" · "stop" · "session_end"
commandrequiredmax length 4000
matchermax length 255
timeout_scustomData▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredpattern ^[a-z0-9_]+$
kindrequired"spreadsheet" · "doc" · "private_api" · "other"
scope"creator" · "user" — default: "creator"
descriptionuriconfigdefault: {}
metadataenvironmentIdThe workspace environment a session of this agent boots in when its create names no `environment_id`; ahead of the workspace default. Omitted = no agent default.
vaultIdA workspace vault every session of this agent carries: after the vaults the session create names, ahead of the workspace default. Omitted = no agent vault.
capabilityPolicies"always_allow" · "always_ask" · "auto"
nativeToolPolicyOwner-only permission for native pod tools; omitted defaults to always_allow. Supported by Claude Code and Codex after native approval rollout. — "always_allow" · "always_ask"
hiringPolicyWhether this agent's sessions may bring in other agents as helpers; omitted defaults to allow. deny makes the agent work alone. — "allow" · "deny"
harnessworkspace_acp only: the public id (hrn_…) of the workspace harness to pin. Required when agentType is workspace_acp.
agentrequiredEverything in the list item, plus configuration state.
▸ Show child attributes▾ Hide child attributes
idThe agent id (agent_…) — the only address
namedisplayNameagentTypellmharnessVersionreasoningEffort"none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra" · null
versionarchivedsessionCountcreatedAtdescriptionpromptThe user prompt layer
promptVersioncapabilitiesThe built-in capabilities this agent is granted — the exact set its sessions may execute (enforced; empty = none). Ids are listed at /docs/capabilities. — "embedding.openai" · "embedding.voyage" · "rerank.voyage" · "ocr.mistral" · "exa.search" · "exa.contents" · "tinyfish.fetch" · "tinyfish.browser" · "tinyfish.agent" · "dataforseo.serp" · "dataforseo.ai-keywords" · "dataforseo.llm-responses" · "dataforseo.app-info" · "dataforseo.app-search" · "dataforseo.backlinks" · "dataforseo.business-reviews" · "dataforseo.business-pinterest" · "dataforseo.content-analysis" · "dataforseo.technologies" · "dataforseo.keyword-data" · "dataforseo.labs" · "dataforseo.amazon" · "dataforseo.onpage" · "gptimage.generate" · "rembg.remove-background" · "seedance.generate" · "mm.i2v" · "wan.t2v" · "wan.i2v" · "happyhorse.t2v" · "minimax.h3" · "fish-audio.transcribe" · "code-review" · "exa.answer" · "googlemap.geocode" · "googlemap.places" · "agentmail.list-inboxes" · "tinyfish.search" · "tinyfish.profile-list" · "meta.transcribe" · "minimax.tts" · "elevenlabs.sound" · "zai.transcribe" · "openai.transcribe" · "fish-audio.tts" · "google.image" · "openai.image-2.5" · "wan.image" · "logo.lookup" · "openmeteo.weather" · "frankfurter.fx" · "dictionary.define" · "openlibrary.search" · "googledns.resolve" · "qrserver.create" · "social-boost.catalog"
capabilityPoliciesPer-capability permission policy map; omitted when no entries exist. always_allow: invoke without user confirmation. always_ask: prompt the session owner before every invocation. auto: reserved for future policy evaluation; currently prompts the session owner like always_ask. — "always_allow" · "always_ask" · "auto"
nativeToolPolicyNative pod-tool permission, independent of capabilities. Returned on create and detail responses; omitted legacy settings mean always_allow. Only the agent owner can change it, while sessions are idle. — "always_allow" · "always_ask"
hiringPolicyWhether this agent's sessions may bring in other agents as helpers. allow unless set to deny. Returned on create and detail responses. — "allow" · "deny"
mcpServersDeclared remote MCP server references, including tool filters; runtime authentication fields are never returned
▸ Show child attributes▾ Hide child attributes
typedefault: "url"
namerequiredmax length 255
urlrequiredtools▸ Show child attributes▾ Hide child attributes
includedefault: []
excludedefault: []
hooksShell commands run in the session's pod at lifecycle events
▸ Show child attributes▾ Hide child attributes
eventrequired"pre_session_start" · "session_start" · "user_prompt_submit" · "pre_tool_use" · "post_tool_use" · "stop" · "session_end"
commandrequiredmax length 4000
matchermax length 255
timeout_smetadataYour key-merged client metadata
environmentIdThe environment sessions of this agent boot in when their create names none; ahead of the workspace default
vaultIdThe vault every session of this agent carries, after the vaults its create names and ahead of the workspace default
defaultSessionIdThe session conversation verbs target when addressed by agent id
universeResolved universe slug
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/agents \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"displayName":"Research Agent","agentType":"hermes","llm":"deepseek-v4-pro","capabilities":["exa.search"]}'{
"agent": {
"id": "agent_cmtb2f0a8m9k7x51q4ez6r0d",
"name": "Research Agent",
"displayName": "Research Agent",
"agentType": "hermes",
"llm": "deepseek-v4-pro",
"version": 1,
"capabilities": [
"exa.search"
],
"defaultSessionId": null,
"universe": "acme"
}
}/agents/{id}readAgent detail
idrequiredThe agent id (agent_…)
agentrequiredEverything in the list item, plus configuration state.
▸ Show child attributes▾ Hide child attributes
idThe agent id (agent_…) — the only address
namedisplayNameagentTypellmharnessVersionreasoningEffort"none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra" · null
versionarchivedsessionCountcreatedAtdescriptionpromptThe user prompt layer
promptVersioncapabilitiesThe built-in capabilities this agent is granted — the exact set its sessions may execute (enforced; empty = none). Ids are listed at /docs/capabilities. — "embedding.openai" · "embedding.voyage" · "rerank.voyage" · "ocr.mistral" · "exa.search" · "exa.contents" · "tinyfish.fetch" · "tinyfish.browser" · "tinyfish.agent" · "dataforseo.serp" · "dataforseo.ai-keywords" · "dataforseo.llm-responses" · "dataforseo.app-info" · "dataforseo.app-search" · "dataforseo.backlinks" · "dataforseo.business-reviews" · "dataforseo.business-pinterest" · "dataforseo.content-analysis" · "dataforseo.technologies" · "dataforseo.keyword-data" · "dataforseo.labs" · "dataforseo.amazon" · "dataforseo.onpage" · "gptimage.generate" · "rembg.remove-background" · "seedance.generate" · "mm.i2v" · "wan.t2v" · "wan.i2v" · "happyhorse.t2v" · "minimax.h3" · "fish-audio.transcribe" · "code-review" · "exa.answer" · "googlemap.geocode" · "googlemap.places" · "agentmail.list-inboxes" · "tinyfish.search" · "tinyfish.profile-list" · "meta.transcribe" · "minimax.tts" · "elevenlabs.sound" · "zai.transcribe" · "openai.transcribe" · "fish-audio.tts" · "google.image" · "openai.image-2.5" · "wan.image" · "logo.lookup" · "openmeteo.weather" · "frankfurter.fx" · "dictionary.define" · "openlibrary.search" · "googledns.resolve" · "qrserver.create" · "social-boost.catalog"
capabilityPoliciesPer-capability permission policy map; omitted when no entries exist. always_allow: invoke without user confirmation. always_ask: prompt the session owner before every invocation. auto: reserved for future policy evaluation; currently prompts the session owner like always_ask. — "always_allow" · "always_ask" · "auto"
nativeToolPolicyNative pod-tool permission, independent of capabilities. Returned on create and detail responses; omitted legacy settings mean always_allow. Only the agent owner can change it, while sessions are idle. — "always_allow" · "always_ask"
hiringPolicyWhether this agent's sessions may bring in other agents as helpers. allow unless set to deny. Returned on create and detail responses. — "allow" · "deny"
mcpServersDeclared remote MCP server references, including tool filters; runtime authentication fields are never returned
▸ Show child attributes▾ Hide child attributes
typedefault: "url"
namerequiredmax length 255
urlrequiredtools▸ Show child attributes▾ Hide child attributes
includedefault: []
excludedefault: []
hooksShell commands run in the session's pod at lifecycle events
▸ Show child attributes▾ Hide child attributes
eventrequired"pre_session_start" · "session_start" · "user_prompt_submit" · "pre_tool_use" · "post_tool_use" · "stop" · "session_end"
commandrequiredmax length 4000
matchermax length 255
timeout_smetadataYour key-merged client metadata
environmentIdThe environment sessions of this agent boot in when their create names none; ahead of the workspace default
vaultIdThe vault every session of this agent carries, after the vaults its create names and ahead of the workspace default
defaultSessionIdThe session conversation verbs target when addressed by agent id
universeResolved universe slug
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d' \
-H "Authorization: Bearer ast_..."/agents/{id}writeUpdate displayName / capabilities / metadata
Omitted fields preserved; capabilities replaced whole (explicit [] revokes all; effective on the next capability call, no restart); metadata key-merged (null deletes a key); optional expectedVersion → 409 version_conflict on mismatch.
idrequiredThe agent id (agent_…)
displayNamemax length 60
capabilities"embedding.openai" · "embedding.voyage" · "rerank.voyage" · "ocr.mistral" · "exa.search" · "exa.contents" · "tinyfish.fetch" · "tinyfish.browser" · "tinyfish.agent" · "dataforseo.serp" · "dataforseo.ai-keywords" · "dataforseo.llm-responses" · "dataforseo.app-info" · "dataforseo.app-search" · "dataforseo.backlinks" · "dataforseo.business-reviews" · "dataforseo.business-pinterest" · "dataforseo.content-analysis" · "dataforseo.technologies" · "dataforseo.keyword-data" · "dataforseo.labs" · "dataforseo.amazon" · "dataforseo.onpage" · "gptimage.generate" · "rembg.remove-background" · "seedance.generate" · "mm.i2v" · "wan.t2v" · "wan.i2v" · "happyhorse.t2v" · "minimax.h3" · "fish-audio.transcribe" · "code-review" · "exa.answer" · "googlemap.geocode" · "googlemap.places" · "agentmail.list-inboxes" · "tinyfish.search" · "tinyfish.profile-list" · "meta.transcribe" · "minimax.tts" · "elevenlabs.sound" · "zai.transcribe" · "openai.transcribe" · "fish-audio.tts" · "google.image" · "openai.image-2.5" · "wan.image" · "logo.lookup" · "openmeteo.weather" · "frankfurter.fx" · "dictionary.define" · "openlibrary.search" · "googledns.resolve" · "qrserver.create" · "social-boost.catalog"
metadataenvironmentIdThe environment sessions of this agent boot in when they name none; null clears, omitted preserves. Applies to sessions created afterwards.
vaultIdThe vault every session of this agent carries; null clears, omitted preserves. Applies to sessions created afterwards.
capabilityPolicies"always_allow" · "always_ask" · "auto"
nativeToolPolicyOwner-only permission for native pod tools. Omitted preserves; changing permission requires idle sessions. There is no session override. — "always_allow" · "always_ask"
hiringPolicyWhether this agent's sessions may bring in other agents as helpers. Omitted preserves. deny refuses the next helper a session tries to start; sessions created afterwards are not told how to hire. — "allow" · "deny"
harnessVersionreasoningEffortHarness-native reasoning effort; null clears the pin and applies model-compatible normalization. Applies from the next provision/restart. Allowed values depend on agentType — agoragentic_acp: not supported; amp_acp: not supported; auggie: not supported; autohand: not supported; cline: not supported; codebuddy_code: not supported; cortex_code: not supported; corust_agent: not supported; crow_cli: not supported; cursor: not supported; deepagents: not supported; devin: not supported; dimcode: not supported; dirac: not supported; factory_droid: not supported; fast_agent: not supported; gemini: not supported; github_copilot_cli: not supported; glm_acp_agent: not supported; antigravity_acp: not supported; goose: not supported; grok_build: not supported; harn: not supported; junie: not supported; kilo: not supported; kimchi: not supported; minimax_code: not supported; minion_code: not supported; mistral_vibe: not supported; nova: not supported; poolside: not supported; qoder: not supported; qwen_code: not supported; sigit: not supported; stakpak: not supported; vtcode: not supported; code_assistant: not supported; docker_cagent: not supported; kiro: not supported; muse_code: not supported; openhands: not supported; hermes: none/minimal/low/medium/high/xhigh/max/ultra; claude_code: low/medium/high/xhigh/max; codex: none/minimal/low/medium/high/xhigh/max; openclaw: not supported; jev: not supported; pi: off/minimal/low/medium/high/xhigh/max; dsh: not supported; kimi_code: not supported; opencode: none/minimal/low/medium/high/xhigh/max; workspace_acp: not supported; models: claude-haiku-4-5: not supported; gemini-3.8-flash: low/medium/high; gemini-3.5-flash: low/medium/high; glm-5.3: low/high/max; glm-5.3-flash: low/high/max; grok-4.6: low/medium/high; grok-4.7: low/medium/high/xhigh; codex/hermes + gpt-6.1-sol: low/medium/high/xhigh/max — "none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra"
skillsReplaces the whole skills array; omitted preserves. Applies from the next provision.
▸ Show child attributes▾ Hide child attributes
type: "skill"▸ Show child attributes▾ Hide child attributes
typerequiredskillIdrequiredversiondefault: "latest"
type: "github"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredrefBranch or commit SHA; default branch when omitted.
tokenSecretRefAgent secret key holding a clone token for private repos.
mcpServersReplaces the whole MCP server list; omitted preserves. Applies from the next provision.
▸ Show child attributes▾ Hide child attributes
typedefault: "url"
namerequiredmax length 255
urlrequiredtools▸ Show child attributes▾ Hide child attributes
includedefault: []
excludedefault: []
hooksReplaces the whole hook list; omitted preserves. Applies from the next provision.
▸ Show child attributes▾ Hide child attributes
eventrequired"pre_session_start" · "session_start" · "user_prompt_submit" · "pre_tool_use" · "post_tool_use" · "stop" · "session_end"
commandrequiredmax length 4000
matchermax length 255
timeout_sexpectedVersionagentrequiredEverything in the list item, plus configuration state.
▸ Show child attributes▾ Hide child attributes
idThe agent id (agent_…) — the only address
namedisplayNameagentTypellmharnessVersionreasoningEffort"none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra" · null
versionarchivedsessionCountcreatedAtdescriptionpromptThe user prompt layer
promptVersioncapabilitiesThe built-in capabilities this agent is granted — the exact set its sessions may execute (enforced; empty = none). Ids are listed at /docs/capabilities. — "embedding.openai" · "embedding.voyage" · "rerank.voyage" · "ocr.mistral" · "exa.search" · "exa.contents" · "tinyfish.fetch" · "tinyfish.browser" · "tinyfish.agent" · "dataforseo.serp" · "dataforseo.ai-keywords" · "dataforseo.llm-responses" · "dataforseo.app-info" · "dataforseo.app-search" · "dataforseo.backlinks" · "dataforseo.business-reviews" · "dataforseo.business-pinterest" · "dataforseo.content-analysis" · "dataforseo.technologies" · "dataforseo.keyword-data" · "dataforseo.labs" · "dataforseo.amazon" · "dataforseo.onpage" · "gptimage.generate" · "rembg.remove-background" · "seedance.generate" · "mm.i2v" · "wan.t2v" · "wan.i2v" · "happyhorse.t2v" · "minimax.h3" · "fish-audio.transcribe" · "code-review" · "exa.answer" · "googlemap.geocode" · "googlemap.places" · "agentmail.list-inboxes" · "tinyfish.search" · "tinyfish.profile-list" · "meta.transcribe" · "minimax.tts" · "elevenlabs.sound" · "zai.transcribe" · "openai.transcribe" · "fish-audio.tts" · "google.image" · "openai.image-2.5" · "wan.image" · "logo.lookup" · "openmeteo.weather" · "frankfurter.fx" · "dictionary.define" · "openlibrary.search" · "googledns.resolve" · "qrserver.create" · "social-boost.catalog"
capabilityPoliciesPer-capability permission policy map; omitted when no entries exist. always_allow: invoke without user confirmation. always_ask: prompt the session owner before every invocation. auto: reserved for future policy evaluation; currently prompts the session owner like always_ask. — "always_allow" · "always_ask" · "auto"
nativeToolPolicyNative pod-tool permission, independent of capabilities. Returned on create and detail responses; omitted legacy settings mean always_allow. Only the agent owner can change it, while sessions are idle. — "always_allow" · "always_ask"
hiringPolicyWhether this agent's sessions may bring in other agents as helpers. allow unless set to deny. Returned on create and detail responses. — "allow" · "deny"
mcpServersDeclared remote MCP server references, including tool filters; runtime authentication fields are never returned
▸ Show child attributes▾ Hide child attributes
typedefault: "url"
namerequiredmax length 255
urlrequiredtools▸ Show child attributes▾ Hide child attributes
includedefault: []
excludedefault: []
hooksShell commands run in the session's pod at lifecycle events
▸ Show child attributes▾ Hide child attributes
eventrequired"pre_session_start" · "session_start" · "user_prompt_submit" · "pre_tool_use" · "post_tool_use" · "stop" · "session_end"
commandrequiredmax length 4000
matchermax length 255
timeout_smetadataYour key-merged client metadata
environmentIdThe environment sessions of this agent boot in when their create names none; ahead of the workspace default
vaultIdThe vault every session of this agent carries, after the vaults its create names and ahead of the workspace default
defaultSessionIdThe session conversation verbs target when addressed by agent id
universeResolved universe slug
{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"displayName":"Research Agent","expectedVersion":1}'/agents/{id}adminDelete the agent — only with zero sessions (409 agent_has_sessions)
idrequiredThe agent id (agent_…)
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d \
-H "Authorization: Bearer ast_..."/agents/{id}/archiveadminArchive the agent — read-only, sessions keep running, new sessions rejected
idrequiredThe agent id (agent_…)
agentrequiredEverything in the list item, plus configuration state.
▸ Show child attributes▾ Hide child attributes
idThe agent id (agent_…) — the only address
namedisplayNameagentTypellmharnessVersionreasoningEffort"none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra" · null
versionarchivedsessionCountcreatedAtdescriptionpromptThe user prompt layer
promptVersioncapabilitiesThe built-in capabilities this agent is granted — the exact set its sessions may execute (enforced; empty = none). Ids are listed at /docs/capabilities. — "embedding.openai" · "embedding.voyage" · "rerank.voyage" · "ocr.mistral" · "exa.search" · "exa.contents" · "tinyfish.fetch" · "tinyfish.browser" · "tinyfish.agent" · "dataforseo.serp" · "dataforseo.ai-keywords" · "dataforseo.llm-responses" · "dataforseo.app-info" · "dataforseo.app-search" · "dataforseo.backlinks" · "dataforseo.business-reviews" · "dataforseo.business-pinterest" · "dataforseo.content-analysis" · "dataforseo.technologies" · "dataforseo.keyword-data" · "dataforseo.labs" · "dataforseo.amazon" · "dataforseo.onpage" · "gptimage.generate" · "rembg.remove-background" · "seedance.generate" · "mm.i2v" · "wan.t2v" · "wan.i2v" · "happyhorse.t2v" · "minimax.h3" · "fish-audio.transcribe" · "code-review" · "exa.answer" · "googlemap.geocode" · "googlemap.places" · "agentmail.list-inboxes" · "tinyfish.search" · "tinyfish.profile-list" · "meta.transcribe" · "minimax.tts" · "elevenlabs.sound" · "zai.transcribe" · "openai.transcribe" · "fish-audio.tts" · "google.image" · "openai.image-2.5" · "wan.image" · "logo.lookup" · "openmeteo.weather" · "frankfurter.fx" · "dictionary.define" · "openlibrary.search" · "googledns.resolve" · "qrserver.create" · "social-boost.catalog"
capabilityPoliciesPer-capability permission policy map; omitted when no entries exist. always_allow: invoke without user confirmation. always_ask: prompt the session owner before every invocation. auto: reserved for future policy evaluation; currently prompts the session owner like always_ask. — "always_allow" · "always_ask" · "auto"
nativeToolPolicyNative pod-tool permission, independent of capabilities. Returned on create and detail responses; omitted legacy settings mean always_allow. Only the agent owner can change it, while sessions are idle. — "always_allow" · "always_ask"
hiringPolicyWhether this agent's sessions may bring in other agents as helpers. allow unless set to deny. Returned on create and detail responses. — "allow" · "deny"
mcpServersDeclared remote MCP server references, including tool filters; runtime authentication fields are never returned
▸ Show child attributes▾ Hide child attributes
typedefault: "url"
namerequiredmax length 255
urlrequiredtools▸ Show child attributes▾ Hide child attributes
includedefault: []
excludedefault: []
hooksShell commands run in the session's pod at lifecycle events
▸ Show child attributes▾ Hide child attributes
eventrequired"pre_session_start" · "session_start" · "user_prompt_submit" · "pre_tool_use" · "post_tool_use" · "stop" · "session_end"
commandrequiredmax length 4000
matchermax length 255
timeout_smetadataYour key-merged client metadata
environmentIdThe environment sessions of this agent boot in when their create names none; ahead of the workspace default
vaultIdThe vault every session of this agent carries, after the vaults its create names and ahead of the workspace default
defaultSessionIdThe session conversation verbs target when addressed by agent id
universeResolved universe slug
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d/archive \
-H "Authorization: Bearer ast_..."/agents/{id}/promptwriteSave the user prompt layer; applies to sessions started after the save
idrequiredThe agent id (agent_…)
promptrequiredmax length 100000
versionunchangedContent identical to the active version
{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d/prompt \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"prompt":"You are a meticulous research agent…"}'Prompt version history
idrequiredThe agent id (agent_…)
versionsrequired▸ Show child attributes▾ Hide child attributes
versionnotecreatedAtactivecontent{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d/prompt/versions' \
-H "Authorization: Bearer ast_..."Declared secret keys + set/unset — never values
idrequiredThe agent id (agent_…)
secretsrequired▸ Show child attributes▾ Hide child attributes
keydescription{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d/secrets' \
-H "Authorization: Bearer ast_..."Set a declared secret's value (write-only)
idrequiredThe agent id (agent_…)
keyrequiredvaluerequiredmax length 10000
descriptionmax length 500
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d/secrets/NOTION_TOKEN \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"value":"secret_…"}'Unset a secret
idrequiredThe agent id (agent_…)
keyrequiredokrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/agents/agent_cmtb2f0a8m9k7x51q4ez6r0d/secrets/NOTION_TOKEN \
-H "Authorization: Bearer ast_..."Skills
/skillsreadList skills in the resolved universe
cursorlimitskillsrequired▸ Show child attributes▾ Hide child attributes
idrequireddisplayNamerequiredlatestRevisionIdrequiredWhat `latest` references resolve to.
attachByDefaultrequiredWhether every new session in the workspace starts with this skill's latest revision.
createdAtrequiredupdatedAtrequirednextCursor{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/skills' \
-H "Authorization: Bearer ast_..."/skillswriteCreate a skill (uploads revision 1)
A skill is a universe-scoped, immutably-revisioned file bundle agents load on demand (RFC-0073). Attach it to agents via the `skills` array on create/patch.
skillrequired▸ Show child attributes▾ Hide child attributes
idrequireddisplayNamerequiredlatestRevisionIdrequiredWhat `latest` references resolve to.
attachByDefaultrequiredWhether every new session in the workspace starts with this skill's latest revision.
createdAtrequiredupdatedAtrequiredrevisionrequired▸ Show child attributes▾ Hide child attributes
idrequiredskillIdrequirednamerequiredFrontmatter name — the skill's identity name.
descriptionrequiredfilesrequired▸ Show child attributes▾ Hide child attributes
pathrequiredsizerequiredsha256requiredexecutablerequiredcreatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/skills \
-H "Authorization: Bearer ast_..."Skill detail
skillIdrequiredThe skill id (skill_…)
skillrequired▸ Show child attributes▾ Hide child attributes
idrequireddisplayNamerequiredlatestRevisionIdrequiredWhat `latest` references resolve to.
attachByDefaultrequiredWhether every new session in the workspace starts with this skill's latest revision.
createdAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/skills/skillId' \
-H "Authorization: Bearer ast_..."/skills/{skillId}writeMake a skill always available, or stop
With `attachByDefault: true`, every session created in the workspace from then on is provisioned with the skill's latest revision, unless the session is created with `defaults: "none"`. Sessions of agents that cannot take skills start without it.
skillIdrequiredThe skill id (skill_…)
attachByDefaultrequiredskillrequired▸ Show child attributes▾ Hide child attributes
idrequireddisplayNamerequiredlatestRevisionIdrequiredWhat `latest` references resolve to.
attachByDefaultrequiredWhether every new session in the workspace starts with this skill's latest revision.
createdAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/skills/skillId \
-H "Authorization: Bearer ast_..."/skills/{skillId}writeDelete a skill and all its revisions
409 skill_in_use while any agent references the skill.
skillIdrequiredThe skill id (skill_…)
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/skills/skillId \
-H "Authorization: Bearer ast_..."List a skill's revisions, newest first
skillIdrequiredThe skill id (skill_…)
revisionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredskillIdrequirednamerequiredFrontmatter name — the skill's identity name.
descriptionrequiredfilesrequired▸ Show child attributes▾ Hide child attributes
pathrequiredsizerequiredsha256requiredexecutablerequiredcreatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/skills/skillId/revisions' \
-H "Authorization: Bearer ast_..."Create a revision — a complete snapshot
Omitted files are not carried over. The new SKILL.md name must match the skill's name (400 name_mismatch).
revisionrequired▸ Show child attributes▾ Hide child attributes
idrequiredskillIdrequirednamerequiredFrontmatter name — the skill's identity name.
descriptionrequiredfilesrequired▸ Show child attributes▾ Hide child attributes
pathrequiredsizerequiredsha256requiredexecutablerequiredcreatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/skills/skillId/revisions \
-H "Authorization: Bearer ast_..."Skill revision detail (metadata + file manifest)
skillIdrequiredThe skill id (skill_…)
revisionIdrequiredThe skill revision id (skr_…)
revisionrequired▸ Show child attributes▾ Hide child attributes
idrequiredskillIdrequirednamerequiredFrontmatter name — the skill's identity name.
descriptionrequiredfilesrequired▸ Show child attributes▾ Hide child attributes
pathrequiredsizerequiredsha256requiredexecutablerequiredcreatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/skills/skillId/revisions/revisionId' \
-H "Authorization: Bearer ast_..."Delete one revision
400 last_revision for a skill's only revision; 409 revision_in_use while pinned by an agent; deleting the latest repoints latestRevisionId.
skillIdrequiredThe skill id (skill_…)
revisionIdrequiredThe skill revision id (skr_…)
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/skills/skillId/revisions/revisionId \
-H "Authorization: Bearer ast_..."Read a UTF-8 skill file
Reads only a file in the authorized immutable revision. Binary files return 415; absent files return 404. Responses are not cached.
skillIdrequiredThe skill id (skill_…)
revisionIdrequiredThe skill revision id (skr_…)
pathrequiredExact relative file path, such as SKILL.md
pathrequiredcontentrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/skills/skillId/revisions/revisionId/content?path=report.md' \
-H "Authorization: Bearer ast_..."Files
/fileswriteUpload a file — universe-scoped; images are readable back, other uploads are write-once
multipart/form-data with a `file` part and an optional `expires_in_seconds` (3600–7776000). 32 MiB per file (413 file_too_large). Reference the returned id from a message as `{"type":"image","source":{"type":"file","file_id":"file_…"}}` or a `document` block.
typerequired"file"
idrequiredfile_…
created_atrequiredfilenamerequiredmime_typerequiredsize_bytesrequireddownloadablerequiredtrue for image uploads (readable within the workspace) and for the per-session copies minted when a file rides a message; false for other uploads (write-once)
attach_by_defaultrequiredWhether every new session in the workspace starts with a read-only copy under /workspace/shared/
expires_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/files \
-H "Authorization: Bearer ast_..." \
-F "file=@report.pdf"{
"type": "file",
"id": "file_cmtb9x4p",
"created_at": "2026-09-10T18:00:00.000Z",
"filename": "design.pdf",
"mime_type": "application/pdf",
"size_bytes": 102400,
"downloadable": false,
"expires_at": null
}/filesreadList files — your universe's uploads, or one session's files
Without `scope_id`, the universe's uploads. `scope_id=sess_…` lists that session's files: the copies minted from message content, channel attachments, and agent-stored files. `ids[]` (≤100) returns exactly those files in one page and cannot be combined with page/limit.
limitpageA next_page cursor
ids[]scope_idsess_…
datarequiredNewest first
▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredfile_…
created_atrequiredfilenamerequiredmime_typerequiredsize_bytesrequireddownloadablerequiredtrue for image uploads (readable within the workspace) and for the per-session copies minted when a file rides a message; false for other uploads (write-once)
attach_by_defaultrequiredWhether every new session in the workspace starts with a read-only copy under /workspace/shared/
expires_atrequirednext_pagerequiredPass back as ?page= for the next page
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/files' \
-H "Authorization: Bearer ast_..."{
"data": [
{
"type": "file",
"id": "file_cmtb9x4p",
"created_at": "2026-09-10T18:00:00.000Z",
"filename": "design.pdf",
"mime_type": "application/pdf",
"size_bytes": 102400,
"downloadable": false,
"expires_at": null
}
],
"next_page": null
}/files/{file_id}readFile metadata
file_idrequiredThe file id (file_…)
typerequired"file"
idrequiredfile_…
created_atrequiredfilenamerequiredmime_typerequiredsize_bytesrequireddownloadablerequiredtrue for image uploads (readable within the workspace) and for the per-session copies minted when a file rides a message; false for other uploads (write-once)
attach_by_defaultrequiredWhether every new session in the workspace starts with a read-only copy under /workspace/shared/
expires_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/files/file_cmtb9x4p' \
-H "Authorization: Bearer ast_..."/files/{file_id}writeMake an upload always available, or stop
With `attach_by_default: true`, every session created in the workspace from then on starts with a read-only copy at `/workspace/shared/<filename>`, unless the session is created with `defaults: "none"`. Only a workspace upload that does not expire can carry the flag (400 otherwise). A file whose name is already taken in a session, or that would take the set past 64 MiB or 50 files, is skipped for that session; the session still starts.
file_idrequiredThe file id (file_…)
attach_by_defaultrequiredtyperequired"file"
idrequiredfile_…
created_atrequiredfilenamerequiredmime_typerequiredsize_bytesrequireddownloadablerequiredtrue for image uploads (readable within the workspace) and for the per-session copies minted when a file rides a message; false for other uploads (write-once)
attach_by_defaultrequiredWhether every new session in the workspace starts with a read-only copy under /workspace/shared/
expires_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/files/file_cmtb9x4p \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"attach_by_default":true}'/files/{file_id}writeDelete a file
Soft delete: the file stops resolving everywhere; sessions that already received a copy keep it.
file_idrequiredThe file id (file_…)
typerequired"file_deleted"
idrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/files/file_cmtb9x4p \
-H "Authorization: Bearer ast_..."{
"type": "file_deleted",
"id": "file_cmtb9x4p"
}Download a file's bytes
Only `downloadable` files (an image upload, readable within the workspace, and every session-scoped file: message copies, channel attachments, agent outputs); other uploads answer 400 not_downloadable. 404 once the file has expired.
file_idrequiredThe file id (file_…)
The bytes, with content-type and content-disposition
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/files/file_cmtb9x4p/content' \
-H "Authorization: Bearer ast_..."Environments
/environmentsreadList the universe's environments, oldest first
environmentsrequired▸ Show child attributes▾ Hide child attributes
idrequiredenv_…
namerequiredconfigrequired`packages` are installed into the image at build time — an environment is built when it is created and rebuilt when its config changes, so a session starting from it pays no install cost. `networking` is the egress policy its sessions run under; `limited` needs `allow_package_managers` when packages are declared, or the install could never succeed.
▸ Show child attributes▾ Hide child attributes
typedefault: "cloud"
packages▸ Show child attributes▾ Hide child attributes
aptdefault: [] — max length 512
pipdefault: [] — max length 512
npmdefault: [] — max length 512
networking▸ Show child attributes▾ Hide child attributes
type: "unrestricted"▸ Show child attributes▾ Hide child attributes
typerequiredtype: "limited"▸ Show child attributes▾ Hide child attributes
typerequiredallowed_hostsdefault: [] — max length 253 — pattern ^(\*\.)?([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?$
allow_mcp_serversdefault: false
allow_package_managersdefault: false
is_defaultrequiredWhether a new session that names no environment uses this one. At most one per workspace; setting it on one clears it on the others.
extendsrequiredThe env_… id of the parent environment this one extends, or null. Immutable after create. Child packages, tools.disabled and networking compose on the parent's at write time.
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/environments' \
-H "Authorization: Bearer ast_..."/environmentswriteCreate an environment
The image build starts immediately; the environment is usable as `environment_id` on POST /sessions as soon as it exists, and a session created against a still-building environment waits for the build. Supplying `extends` (an `env_…` id in the same workspace) composes packages, tools.disabled and networking from the parent at write time and records the lineage. `extends` is immutable after create; chain depth is capped at 16.
namerequiredmax length 128
configdefault: {"type":"cloud"}
▸ Show child attributes▾ Hide child attributes
typedefault: "cloud"
packages▸ Show child attributes▾ Hide child attributes
aptdefault: [] — max length 512
pipdefault: [] — max length 512
npmdefault: [] — max length 512
networking▸ Show child attributes▾ Hide child attributes
type: "unrestricted"▸ Show child attributes▾ Hide child attributes
typerequiredtype: "limited"▸ Show child attributes▾ Hide child attributes
typerequiredallowed_hostsdefault: [] — max length 253 — pattern ^(\*\.)?([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?$
allow_mcp_serversdefault: false
allow_package_managersdefault: false
extendsenvironmentrequired▸ Show child attributes▾ Hide child attributes
idrequiredenv_…
namerequiredconfigrequired`packages` are installed into the image at build time — an environment is built when it is created and rebuilt when its config changes, so a session starting from it pays no install cost. `networking` is the egress policy its sessions run under; `limited` needs `allow_package_managers` when packages are declared, or the install could never succeed.
▸ Show child attributes▾ Hide child attributes
typedefault: "cloud"
packages▸ Show child attributes▾ Hide child attributes
aptdefault: [] — max length 512
pipdefault: [] — max length 512
npmdefault: [] — max length 512
networking▸ Show child attributes▾ Hide child attributes
type: "unrestricted"▸ Show child attributes▾ Hide child attributes
typerequiredtype: "limited"▸ Show child attributes▾ Hide child attributes
typerequiredallowed_hostsdefault: [] — max length 253 — pattern ^(\*\.)?([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?$
allow_mcp_serversdefault: false
allow_package_managersdefault: false
is_defaultrequiredWhether a new session that names no environment uses this one. At most one per workspace; setting it on one clears it on the others.
extendsrequiredThe env_… id of the parent environment this one extends, or null. Immutable after create. Child packages, tools.disabled and networking compose on the parent's at write time.
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/environments \
-H "Authorization: Bearer ast_..."One environment
idrequiredThe environment id (env_…)
environmentrequired▸ Show child attributes▾ Hide child attributes
idrequiredenv_…
namerequiredconfigrequired`packages` are installed into the image at build time — an environment is built when it is created and rebuilt when its config changes, so a session starting from it pays no install cost. `networking` is the egress policy its sessions run under; `limited` needs `allow_package_managers` when packages are declared, or the install could never succeed.
▸ Show child attributes▾ Hide child attributes
typedefault: "cloud"
packages▸ Show child attributes▾ Hide child attributes
aptdefault: [] — max length 512
pipdefault: [] — max length 512
npmdefault: [] — max length 512
networking▸ Show child attributes▾ Hide child attributes
type: "unrestricted"▸ Show child attributes▾ Hide child attributes
typerequiredtype: "limited"▸ Show child attributes▾ Hide child attributes
typerequiredallowed_hostsdefault: [] — max length 253 — pattern ^(\*\.)?([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?$
allow_mcp_serversdefault: false
allow_package_managersdefault: false
is_defaultrequiredWhether a new session that names no environment uses this one. At most one per workspace; setting it on one clears it on the others.
extendsrequiredThe env_… id of the parent environment this one extends, or null. Immutable after create. Child packages, tools.disabled and networking compose on the parent's at write time.
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/environments/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/environments/{id}writeRename an environment or change its config
Omitted fields are left as they are. A changed `config` rebuilds the image; sessions already running keep the image they started on.
idrequiredThe environment id (env_…)
namemax length 128
config▸ Show child attributes▾ Hide child attributes
typedefault: "cloud"
packages▸ Show child attributes▾ Hide child attributes
aptdefault: [] — max length 512
pipdefault: [] — max length 512
npmdefault: [] — max length 512
networking▸ Show child attributes▾ Hide child attributes
type: "unrestricted"▸ Show child attributes▾ Hide child attributes
typerequiredtype: "limited"▸ Show child attributes▾ Hide child attributes
typerequiredallowed_hostsdefault: [] — max length 253 — pattern ^(\*\.)?([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?$
allow_mcp_serversdefault: false
allow_package_managersdefault: false
environmentrequired▸ Show child attributes▾ Hide child attributes
idrequiredenv_…
namerequiredconfigrequired`packages` are installed into the image at build time — an environment is built when it is created and rebuilt when its config changes, so a session starting from it pays no install cost. `networking` is the egress policy its sessions run under; `limited` needs `allow_package_managers` when packages are declared, or the install could never succeed.
▸ Show child attributes▾ Hide child attributes
typedefault: "cloud"
packages▸ Show child attributes▾ Hide child attributes
aptdefault: [] — max length 512
pipdefault: [] — max length 512
npmdefault: [] — max length 512
networking▸ Show child attributes▾ Hide child attributes
type: "unrestricted"▸ Show child attributes▾ Hide child attributes
typerequiredtype: "limited"▸ Show child attributes▾ Hide child attributes
typerequiredallowed_hostsdefault: [] — max length 253 — pattern ^(\*\.)?([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?$
allow_mcp_serversdefault: false
allow_package_managersdefault: false
is_defaultrequiredWhether a new session that names no environment uses this one. At most one per workspace; setting it on one clears it on the others.
extendsrequiredThe env_… id of the parent environment this one extends, or null. Immutable after create. Child packages, tools.disabled and networking compose on the parent's at write time.
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/environments/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."/environments/{id}writeDelete an environment
idrequiredThe environment id (env_…)
Deleted — no body
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/environments/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Publish one of your own environments as a listing
Creates or replaces the listing for this environment on the shelf. The environment must belong to the caller's workspace. Answers 404 when the shelf is not enabled for this workspace or the environment is not found. Answers 503 `not_migrated` until the shelf migration is applied.
idrequiredThe environment id (env_…)
handlerequired2 to 40 lower-case letters, digits or underscores; unique across environment listings
namerequiredmax length 128
taglinemax length 140
descriptionmax length 4000
categoriesDefaults to general — "development" · "data" · "ml" · "security" · "web" · "general"
visibilityOnly workspace is supported in this release — "workspace" — default: "workspace"
listingrequired▸ Show child attributes▾ Hide child attributes
idrequiredThe listing id (lst_…)
handlerequiredGlobally unique within environment listings; lower-case letters, digits and underscores
namerequiredtaglinerequiredOne line, at most 140 characters
descriptionrequiredcategoriesrequired"development" · "data" · "ml" · "security" · "web" · "general"
packagesrequiredThe listed environment's package configuration, or null when it has none
toolsrequiredThe listed environment's tool policy, or null when it has none
networkingrequiredThe listed environment's networking configuration, or null when it has none
installsrequiredHow many workspaces have installed this listing
sellerrequiredThe workspace that published the listing
▸ Show child attributes▾ Hide child attributes
namerequiredvisibilityrequiredworkspace = visible only to the owning workspace; public = visible to all — "workspace" · "public"
conformancerequiredReserved; always null in this release
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/environments/sess_cmtb7q2j/listing \
-H "Authorization: Bearer ast_..."Remove the listing for one of your own environments
Delists the environment; the environment itself and any installed copies in other workspaces are not touched. Answers 404 when the shelf is not enabled, the environment is not found, or it has no listing. Answers 503 `not_migrated` until the shelf migration is applied.
idrequiredThe environment id (env_…)
Delisted
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/environments/sess_cmtb7q2j/listing \
-H "Authorization: Bearer ast_..."Harnesses
/harnessesreadList workspace harnesses, oldest first
Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
harnessesrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrn_… — the public id
handlerequiredShort slug within the workspace (e.g. my-harness)
namerequiredprofilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturesmodel_billingrequiredgateway: model calls are billed through the platform wallet. external: the harness manages billing itself. — "gateway" · "external"
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/harnesses' \
-H "Authorization: Bearer ast_..."/harnesseswriteCreate a harness
Creates a workspace harness with the given handle, name and profile. After creating, add a version with POST /harnesses/{id}/versions, then promote it with POST /harnesses/{id}/versions/{v}/current before creating agents that reference it. Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
handlerequiredpattern ^[a-z0-9][a-z0-9-]{1,38}[a-z0-9]$
namerequiredmax length 200
profilerequired▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturesmodel_billing"gateway" · "external" — default: "external"
harnessrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrn_… — the public id
handlerequiredShort slug within the workspace (e.g. my-harness)
namerequiredprofilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturesmodel_billingrequiredgateway: model calls are billed through the platform wallet. external: the harness manages billing itself. — "gateway" · "external"
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/harnesses \
-H "Authorization: Bearer ast_..."/harnesses/{id}readOne harness
Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
harnessrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrn_… — the public id
handlerequiredShort slug within the workspace (e.g. my-harness)
namerequiredprofilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturesmodel_billingrequiredgateway: model calls are billed through the platform wallet. external: the harness manages billing itself. — "gateway" · "external"
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/harnesses/{id}writeRename a harness or change its model_billing
Omitted fields are left unchanged. Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
namemax length 200
model_billing"gateway" · "external"
harnessrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrn_… — the public id
handlerequiredShort slug within the workspace (e.g. my-harness)
namerequiredprofilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturesmodel_billingrequiredgateway: model calls are billed through the platform wallet. external: the harness manages billing itself. — "gateway" · "external"
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."/harnesses/{id}writeDelete a harness
Deletes the harness and all its versions. Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
Deleted — no body
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."List versions for a harness, oldest first
Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
versionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrnv_… — internal version row id
harness_idrequiredhrn_… — the parent harness
versionrequiredVersion string, e.g. v1-4096m
statusrequiredpending: registered, build not started. building: E2B template build in progress. ready: build succeeded; can be promoted. current: the version agents are created against; at most one per harness. revoked: explicitly withdrawn; cannot be promoted or used for new sessions. — "pending" · "building" · "ready" · "current" · "revoked"
profilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturescreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j/versions' \
-H "Authorization: Bearer ast_..."Register a new harness version
Registers the version string and triggers an E2B template build. Poll the version's status until it reaches ready, then promote with POST /harnesses/{id}/versions/{v}/current. If profile is omitted, the parent harness's profile is used. Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
versionrequiredmax length 128
profile▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturesversionrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrnv_… — internal version row id
harness_idrequiredhrn_… — the parent harness
versionrequiredVersion string, e.g. v1-4096m
statusrequiredpending: registered, build not started. building: E2B template build in progress. ready: build succeeded; can be promoted. current: the version agents are created against; at most one per harness. revoked: explicitly withdrawn; cannot be promoted or used for new sessions. — "pending" · "building" · "ready" · "current" · "revoked"
profilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturescreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j/versions \
-H "Authorization: Bearer ast_..."One harness version
Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
vrequiredThe harness version string, e.g. v1-4096m
versionrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrnv_… — internal version row id
harness_idrequiredhrn_… — the parent harness
versionrequiredVersion string, e.g. v1-4096m
statusrequiredpending: registered, build not started. building: E2B template build in progress. ready: build succeeded; can be promoted. current: the version agents are created against; at most one per harness. revoked: explicitly withdrawn; cannot be promoted or used for new sessions. — "pending" · "building" · "ready" · "current" · "revoked"
profilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturescreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j/versions/v' \
-H "Authorization: Bearer ast_..."Promote a version to current
Marks this version as the current one for the harness. The previous current version moves back to ready. New agents created against this harness will pin this version. The version must be in ready or current status; a revoked version cannot be promoted. Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
vrequiredThe harness version string, e.g. v1-4096m
versionrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrnv_… — internal version row id
harness_idrequiredhrn_… — the parent harness
versionrequiredVersion string, e.g. v1-4096m
statusrequiredpending: registered, build not started. building: E2B template build in progress. ready: build succeeded; can be promoted. current: the version agents are created against; at most one per harness. revoked: explicitly withdrawn; cannot be promoted or used for new sessions. — "pending" · "building" · "ready" · "current" · "revoked"
profilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturescreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j/versions/v/current \
-H "Authorization: Bearer ast_..."Revoke a harness version
Permanently withdraws a version; it cannot be promoted or used for new sessions. Sessions already running on this version continue until they terminate. Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
vrequiredThe harness version string, e.g. v1-4096m
versionrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrnv_… — internal version row id
harness_idrequiredhrn_… — the parent harness
versionrequiredVersion string, e.g. v1-4096m
statusrequiredpending: registered, build not started. building: E2B template build in progress. ready: build succeeded; can be promoted. current: the version agents are created against; at most one per harness. revoked: explicitly withdrawn; cannot be promoted or used for new sessions. — "pending" · "building" · "ready" · "current" · "revoked"
profilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturescreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j/versions/v/revoke \
-H "Authorization: Bearer ast_..."Record the E2B template listing for a version
Stores the E2B sandbox listing string for the built template. Called by the build pipeline after a successful build; advances the version status to ready. Returns 404 when the WORKSPACE_HARNESSES feature switch is off for this workspace. Returns 503 not_migrated when the backing tables are not yet present.
idrequiredThe harness id (hrn_…)
vrequiredThe harness version string, e.g. v1-4096m
listingrequiredversionrequired▸ Show child attributes▾ Hide child attributes
idrequiredhrnv_… — internal version row id
harness_idrequiredhrn_… — the parent harness
versionrequiredVersion string, e.g. v1-4096m
statusrequiredpending: registered, build not started. building: E2B template build in progress. ready: build succeeded; can be promoted. current: the version agents are created against; at most one per harness. revoked: explicitly withdrawn; cannot be promoted or used for new sessions. — "pending" · "building" · "ready" · "current" · "revoked"
profilerequiredThe runtime description of a workspace harness: the distribution spec (npx, uvx or binary), optional auth command, bundled MCP servers, tools, features and other catalog fields the installer reads when it builds the template image.
▸ Show child attributes▾ Hide child attributes
idrequiredpattern ^[a-z0-9][a-z0-9_-]{1,39}$
namerequiredmax length 200
versionrequiredmax length 128
distributionrequiredauth_commandbundled_mcp_serversconfiguration_filescredential_argsgraceful_exit_timeout_secondshome_directoriesmanaged_model_id_templatenative_provider_setuppipelineprerequisitesrequest_timeout_secondsrequirementssession_close_before_exitsession_config_optionssession_load_supportedsession_parameterssubscription_filesdocker_targettools▸ Show child attributes▾ Hide child attributes
idrequiredkindrequiredtitlerequiresfeaturescreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/harnesses/sess_cmtb7q2j/versions/v/verify \
-H "Authorization: Bearer ast_..."Vaults
/vaultsreadList the universe's vaults, oldest first
vaultsrequired▸ Show child attributes▾ Hide child attributes
typerequired"vault"
idrequiredvlt_…
display_namerequiredcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/vaults' \
-H "Authorization: Bearer ast_..."/vaultswriteCreate a vault
Pass its id in `vault_ids` on POST /sessions to grant a session its secrets.
display_namerequiredmax length 128
vaultrequired▸ Show child attributes▾ Hide child attributes
typerequired"vault"
idrequiredvlt_…
display_namerequiredcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/vaults \
-H "Authorization: Bearer ast_..."/vaults/{id}readOne vault
idrequiredThe vault id (vlt_…)
vaultrequired▸ Show child attributes▾ Hide child attributes
typerequired"vault"
idrequiredvlt_…
display_namerequiredcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/vaults/{id}writeDelete a vault and every secret in it
The revocation is pushed to the pods of any sessions the vault was attached to — they lose the credentials without restarting.
idrequiredThe vault id (vlt_…)
Deleted — no body
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."List a vault's secrets
idrequiredThe vault id (vlt_…)
secretsrequired▸ Show child attributes▾ Hide child attributes
typerequired"vault_secret"
idrequiredvsec_…
display_namerequiredauth_typerequired"static_bearer" · "mcp_oauth" · "environment_variable"
mcp_server_urlsecret_nameThe environment variable the pod sees
statusrequiredexpires_atcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j/secrets' \
-H "Authorization: Bearer ast_..."/vaults/{id}/secretswriteAdd a secret to a vault
`auth.type` picks the kind: static_bearer and mcp_oauth authenticate an MCP server at `mcp_server_url`; environment_variable exposes `secret_name` to the pod. The value is encrypted at rest and never returned.
idrequiredThe vault id (vlt_…)
display_namerequiredmax length 128
authrequired▸ Show child attributes▾ Hide child attributes
type: "static_bearer"▸ Show child attributes▾ Hide child attributes
typerequiredmcp_server_urlrequiredhttps, public host
tokenrequiredtype: "mcp_oauth"▸ Show child attributes▾ Hide child attributes
typerequiredmcp_server_urlrequiredhttps, public host
access_tokenrequiredscopeexpires_atrefresh▸ Show child attributes▾ Hide child attributes
token_endpointrequiredclient_idrequiredclient_secretrefresh_tokenrequiredtoken_endpoint_auth"none" · "client_secret_basic" · "client_secret_post" — default: "none"
type: "environment_variable"▸ Show child attributes▾ Hide child attributes
typerequiredsecret_namerequiredA valid environment variable name — max length 128
valuerequiredallowed_hostsdefault: []
injection_locationdefault: {"header":true,"body":false}
▸ Show child attributes▾ Hide child attributes
headerbodyheader_namevalue_templatemax length 256
secretrequiredMetadata only — the secret value is never returned after it is written. `secret_name` is set for environment_variable secrets, `mcp_server_url` for the two MCP kinds.
▸ Show child attributes▾ Hide child attributes
typerequired"vault_secret"
idrequiredvsec_…
display_namerequiredauth_typerequired"static_bearer" · "mcp_oauth" · "environment_variable"
mcp_server_urlsecret_nameThe environment variable the pod sees
statusrequiredexpires_atcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j/secrets \
-H "Authorization: Bearer ast_..."Move the secrets of other vaults into this one
Moves every secret of the `from` vaults of the same workspace into this vault and answers what happened to each, by name; a value is never returned. A secret is copied and confirmed stored before its source copy is touched, and the source copy is removed only when no session that is not archived still uses that vault without this one (`source` says which). A name this vault already holds with another value is a `clash` and is left alone unless it is listed in `replace`. A secret past this vault's limit, or one that could not be applied together with this vault's secrets, is `blocked` with a `reason`. Calling again moves nothing twice: what is already here answers `already`. With `dry_run` nothing is written and the outcomes are what a real call would do.
idrequiredThe vault id (vlt_…)
fromrequiredThe vaults to move out of (vlt_…) — max length 128
replaceClashing names to overwrite in this vault with the named source's secret
▸ Show child attributes▾ Hide child attributes
fromrequiredmax length 128
namerequiredmax length 256
dry_rundry_runrequiredsecretsrequired▸ Show child attributes▾ Hide child attributes
fromrequiredThe vault it was in (vlt_…)
namerequiredThe environment variable name, or the display name of an MCP secret
auth_typerequired"static_bearer" · "mcp_oauth" · "environment_variable"
outcomerequired"moved" · "already" · "clash" · "blocked"
sourcerequiredWhether the copy in the source vault was removed — "removed" · "kept"
reasonWhy a secret is blocked, e.g. limit_reached or egress_header_conflict
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j/secrets/move \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"from":["vlt_cmtb7q2j"],"dry_run":true}'Rotate or re-scope a secret in place
The secret keeps its id and its placeholder, so attached pods need no restart — the recompiled policy is pushed to them. Fields not sent are left as they are; `injection_location` merges per field.
idrequiredThe vault id (vlt_…)
secretIdrequiredThe secret id (vsec_…)
display_namemax length 128
valuetokenallowed_hostsinjection_location▸ Show child attributes▾ Hide child attributes
headerbodyheader_namevalue_templatemax length 256
secretrequiredMetadata only — the secret value is never returned after it is written. `secret_name` is set for environment_variable secrets, `mcp_server_url` for the two MCP kinds.
▸ Show child attributes▾ Hide child attributes
typerequired"vault_secret"
idrequiredvsec_…
display_namerequiredauth_typerequired"static_bearer" · "mcp_oauth" · "environment_variable"
mcp_server_urlsecret_nameThe environment variable the pod sees
statusrequiredexpires_atcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j/secrets/secretId \
-H "Authorization: Bearer ast_..."Delete a secret
idrequiredThe vault id (vlt_…)
secretIdrequiredThe secret id (vsec_…)
Deleted — no body
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j/secrets/secretId \
-H "Authorization: Bearer ast_..."Exercise an mcp_oauth grant and report whether it still works
idrequiredThe vault id (vlt_…)
secretIdrequiredThe secret id (vsec_…)
resultrequired"valid" · "invalid" · "unknown"
detailsecretrequiredMetadata only — the secret value is never returned after it is written. `secret_name` is set for environment_variable secrets, `mcp_server_url` for the two MCP kinds.
▸ Show child attributes▾ Hide child attributes
typerequired"vault_secret"
idrequiredvsec_…
display_namerequiredauth_typerequired"static_bearer" · "mcp_oauth" · "environment_variable"
mcp_server_urlsecret_nameThe environment variable the pod sees
statusrequiredexpires_atcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/vaults/sess_cmtb7q2j/secrets/secretId/validate \
-H "Authorization: Bearer ast_..."Sessions
/sessionsreadList sessions; ?agent= filters to one spec
agentThe agent id (agent_…)
sessionsrequired▸ Show child attributes▾ Hide child attributes
idsess_… identifier
agentIdThe agent id (agent_…)
titlestatusprovisioning = the sandbox is booting or installing the environment's packages (a turn sent meanwhile waits for it); running = a turn is in flight; terminated = archived or the last runtime was destroyed. Use archived for the durable archive receipt — "provisioning" · "idle" · "running" · "terminated"
archivedTrue only after this Session's archive mark was durably written; false for an active Session whose runtime was destroyed
agentTypellmThe model this session runs on (PATCH to change; the agent's model is unchanged)
harnessVersionHarness release the session runs: the one its serving pod booted, the restored checkpoint's for a native-fork handoff, the agent's pin for ACP harnesses, otherwise the current release
reasoningEffortThe model-compatible effort resolved from the session pin, then agent pin. Constrained models use an allowed fallback; no-setting models return null. Unpinned unconstrained models return null for the harness default.
subscriptionApiFallbackOpt-in to paid API continuation after all subscription accounts exhaust, preserving the same supported explicit model and wallet/budget gates
modelBillingWho pays for model calls: platform wallet or the user's connected subscription — "platform" · "account"
idleTimeoutSecondsSeconds the session's machine stays awake after a turn ends before it is paused; null = the platform default of 60. Set it when people use apps on the session's exposed ports after the agent finishes
defaultIs this the agent's default session
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnamemetadatabudgetHard spend cap, or null when the session has none. A reached budget pauses the session (402 budget_reached on new work) until the cap is raised above consumed_cost or removed — removal is one-way.
resourcesThe files, GitHub repositories, and read-only memory stores mounted into the session, oldest first
▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequiredworkspaceDefaultsWhat the session started with because its workspace made it a default; everything else it carries was named at creation. Null when it took nothing.
hostedBySellerPresent only when the session runs on its agent's maker's own server instead of a sandbox: what is sent to the session goes to this host. `agentType` and `llm` then name a stand-in that never runs.
▸ Show child attributes▾ Hide child attributes
hostrequiredattachmentsEverything the session started with: its environment, vaults, mounted files and memory stores, and the workspace's always-available skills. The skills of the session's agent are on the agent and are not repeated here.
▸ Show child attributes▾ Hide child attributes
typerequired"environment" · "vault" · "file" · "skill" · "memory_store"
idrequiredThe id of the environment, vault, file, skill or memory store
mountPathrequiredWhere a file or memory store is mounted; null for the other types
sourcerequireddefault = the workspace supplied it; explicit = it was named when the session was created. A memory store on a session created before 2026-10-06 reads as explicit — "default" · "explicit"
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions' \
-H "Authorization: Bearer ast_..."/sessionswriteCreate a session — starts provisioning by default; optionally defer until the first turn
Optional llm and reasoningEffort override the agent's defaults for this session before billing selection or provisioning. A model must be current for the agent's harness; omitted or null reasoningEffort inherits the agent's setting normalized for the target model. Explicit effort must fit both harness and target model. A non-empty initial_events list (user.message only, all-or-nothing) starts the first turn in the same call and provisions in either mode. Without initial events, provision: "deferred" skips the boot: the session reads idle with no pod and costs nothing until its first turn — for a session that waits on a gate or a schedule. Machine shape (vcpus/memoryMb) is per-session.
agentrequiredAn agent id, or "@handle" for an agent from the catalog (GET /catalog/agents). A handle that names a platform engine uses the workspace's agent for that engine, created on first use.
llmModel for this session (a current model for the agent's harness). Omitted = the agent's model
reasoningEffortReasoning effort for this session; omitted or null inherits the agent's setting normalized for the target model. Explicit values must fit both harness and target model - agoragentic_acp: not supported; amp_acp: not supported; auggie: not supported; autohand: not supported; cline: not supported; codebuddy_code: not supported; cortex_code: not supported; corust_agent: not supported; crow_cli: not supported; cursor: not supported; deepagents: not supported; devin: not supported; dimcode: not supported; dirac: not supported; factory_droid: not supported; fast_agent: not supported; gemini: not supported; github_copilot_cli: not supported; glm_acp_agent: not supported; antigravity_acp: not supported; goose: not supported; grok_build: not supported; harn: not supported; junie: not supported; kilo: not supported; kimchi: not supported; minimax_code: not supported; minion_code: not supported; mistral_vibe: not supported; nova: not supported; poolside: not supported; qoder: not supported; qwen_code: not supported; sigit: not supported; stakpak: not supported; vtcode: not supported; code_assistant: not supported; docker_cagent: not supported; kiro: not supported; muse_code: not supported; openhands: not supported; hermes: none/minimal/low/medium/high/xhigh/max/ultra; claude_code: low/medium/high/xhigh/max; codex: none/minimal/low/medium/high/xhigh/max; openclaw: not supported; jev: not supported; pi: off/minimal/low/medium/high/xhigh/max; dsh: not supported; kimi_code: not supported; opencode: none/minimal/low/medium/high/xhigh/max; workspace_acp: not supported; models: claude-haiku-4-5: not supported; gemini-3.8-flash: low/medium/high; gemini-3.5-flash: low/medium/high; glm-5.3: low/high/max; glm-5.3-flash: low/high/max; grok-4.6: low/medium/high; grok-4.7: low/medium/high/xhigh; codex/hermes + gpt-6.1-sol: low/medium/high/xhigh/max — "none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra"
titlemax length 120
metadataidleTimeoutSecondsSeconds this session's machine stays awake after a turn ends before it is paused (60-86400; omitted = the platform default of 60). A paused machine wakes on the next message; apps the agent serves on exposed ports are unreachable while it is paused, so set this to how long people keep using them after the agent finishes
instructions▸ Show child attributes▾ Hide child attributes
namerequiredpattern .*\.md$
contentdefault: ""
initial_events▸ Show child attributes▾ Hide child attributes
typerequiredcontentrequired▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "image"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtype: "document"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "text"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typedefault: "text/plain"
datarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtitlecontextinteraction_mode"plan" · "build"
provisioneager (default) boots the sandbox as soon as the row exists; deferred leaves the session idle with no pod until its first turn, so a session waiting on a gate or a schedule costs nothing while it waits. Ignored when initial_events start the first turn — "eager" · "deferred"
environment_idvault_idsvcpusmemoryMbsubscriptionApiFallbackAfter every subscription account is exhausted, continue on the same model using the paid platform API; wallet and session budget still apply
modelBillingWho pays for model calls: platform wallet or the user's connected subscription. Omitted = auto-apply (a connected subscription with "use for new agents" powers eligible compositions) — "platform" · "account"
budgetHard spend cap for this session. Attachable only at create; changeable or removable later via PATCH (removal is one-way)
▸ Show child attributes▾ Hide child attributes
typerequiredmax_list_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents as an integer decimal string, e.g. "125" for $1.25 — max length 15
currencyrequiredpayerWhich balance pays for the session, in a team workspace that has a wallet of its own: "workspace" (the default there) or "personal", the caller's own. Decided once, here, and shown as `payer` on the session and its task. "workspace" where the workspace has no wallet is refused with 409 workspace_wallet_unavailable. — "personal" · "workspace"
defaultsWhether the session also starts with its workspace's defaults: the default environment when none is named, the default vault when it holds a secret, and the always-available files and skills. "none" attaches only what this request names. Omitted means "workspace". — "workspace" · "none"
resourcesFiles, GitHub repositories, and team Memory Stores attached before the first turn (max 100 create-time resources; max 8 memory stores). `{type:"file", file_id, mount_path?}` copies an upload read-only to `/workspace<mount_path>` (default `/workspace/<file_id>`); `{type:"github_repository", url, authorization_token?, checkout?: {type:"branch", name} | {type:"commit", sha}, mount_path?}` clones `https://github.com/{owner}/{repo}` to `/workspace<mount_path>` (default `/workspace/<repo>`); the token never enters the sandbox. `{type:"memory_store", memory_store_id, access:"read_only"|"read_write", mount_path?, instructions?}` attaches a creation-time snapshot under `/mnt/memory/` (default `/mnt/memory/<memory_store_id>`; 8 MiB total per Session). `read_write` explicitly grants the session-scoped Agent API permission to update this store; the mounted snapshot remains read-only.
▸ Show child attributes▾ Hide child attributes
type: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredmax length 128
mount_pathmax length 4096
type: "github_repository"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredmax length 2048
authorization_tokenmax length 1024
checkout▸ Show child attributes▾ Hide child attributes
type: "branch"▸ Show child attributes▾ Hide child attributes
typerequirednamerequiredmax length 255
type: "commit"▸ Show child attributes▾ Hide child attributes
typerequiredsharequiredmax length 64
mount_pathmax length 4096
type: "memory_store"▸ Show child attributes▾ Hide child attributes
typerequiredmemory_store_idrequiredmax length 255
accessrequired"read_only" · "read_write"
instructionsmax length 4096
mount_pathmax length 4096
sessionrequired▸ Show child attributes▾ Hide child attributes
idsess_… identifier
agentIdThe agent id (agent_…)
titlestatusprovisioning = the sandbox is booting or installing the environment's packages (a turn sent meanwhile waits for it); running = a turn is in flight; terminated = archived or the last runtime was destroyed. Use archived for the durable archive receipt — "provisioning" · "idle" · "running" · "terminated"
archivedTrue only after this Session's archive mark was durably written; false for an active Session whose runtime was destroyed
agentTypellmThe model this session runs on (PATCH to change; the agent's model is unchanged)
harnessVersionHarness release the session runs: the one its serving pod booted, the restored checkpoint's for a native-fork handoff, the agent's pin for ACP harnesses, otherwise the current release
reasoningEffortThe model-compatible effort resolved from the session pin, then agent pin. Constrained models use an allowed fallback; no-setting models return null. Unpinned unconstrained models return null for the harness default.
subscriptionApiFallbackOpt-in to paid API continuation after all subscription accounts exhaust, preserving the same supported explicit model and wallet/budget gates
modelBillingWho pays for model calls: platform wallet or the user's connected subscription — "platform" · "account"
idleTimeoutSecondsSeconds the session's machine stays awake after a turn ends before it is paused; null = the platform default of 60. Set it when people use apps on the session's exposed ports after the agent finishes
defaultIs this the agent's default session
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnamemetadatabudgetHard spend cap, or null when the session has none. A reached budget pauses the session (402 budget_reached on new work) until the cap is raised above consumed_cost or removed — removal is one-way.
resourcesThe files, GitHub repositories, and read-only memory stores mounted into the session, oldest first
▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequiredworkspaceDefaultsWhat the session started with because its workspace made it a default; everything else it carries was named at creation. Null when it took nothing.
hostedBySellerPresent only when the session runs on its agent's maker's own server instead of a sandbox: what is sent to the session goes to this host. `agentType` and `llm` then name a stand-in that never runs.
▸ Show child attributes▾ Hide child attributes
hostrequiredattachmentsEverything the session started with: its environment, vaults, mounted files and memory stores, and the workspace's always-available skills. The skills of the session's agent are on the agent and are not repeated here.
▸ Show child attributes▾ Hide child attributes
typerequired"environment" · "vault" · "file" · "skill" · "memory_store"
idrequiredThe id of the environment, vault, file, skill or memory store
mountPathrequiredWhere a file or memory store is mounted; null for the other types
sourcerequireddefault = the workspace supplied it; explicit = it was named when the session was created. A memory store on a session created before 2026-10-06 reads as explicit — "default" · "explicit"
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"agent":"agent_cmtb2f0a8m9k7x51q4ez6r0d","llm":"deepseek-flash","reasoningEffort":"high","title":"Signups digest","resources":[{"type":"file","file_id":"file_cmtb9x4p","mount_path":"/data/signups.csv"},{"type":"github_repository","url":"https://github.com/acme/growth","checkout":{"type":"branch","name":"main"}},{"type":"memory_store","memory_store_id":"memstore_cmtb9x4p","access":"read_only"}],"initial_events":[{"type":"user.message","content":[{"type":"text","text":"Summarize the signups from today"}]}]}'{
"session": {
"id": "sess-8c41f0…",
"agent": "research-agent",
"status": "idle",
"default": true
}
}/sessions/{id}readSession detail — status is provisioning (sandbox booting or installing packages) | idle | running | terminated
idrequiredThe session id
sessionrequired▸ Show child attributes▾ Hide child attributes
idsess_… identifier
agentIdThe agent id (agent_…)
titlestatusprovisioning = the sandbox is booting or installing the environment's packages (a turn sent meanwhile waits for it); running = a turn is in flight; terminated = archived or the last runtime was destroyed. Use archived for the durable archive receipt — "provisioning" · "idle" · "running" · "terminated"
archivedTrue only after this Session's archive mark was durably written; false for an active Session whose runtime was destroyed
agentTypellmThe model this session runs on (PATCH to change; the agent's model is unchanged)
harnessVersionHarness release the session runs: the one its serving pod booted, the restored checkpoint's for a native-fork handoff, the agent's pin for ACP harnesses, otherwise the current release
reasoningEffortThe model-compatible effort resolved from the session pin, then agent pin. Constrained models use an allowed fallback; no-setting models return null. Unpinned unconstrained models return null for the harness default.
subscriptionApiFallbackOpt-in to paid API continuation after all subscription accounts exhaust, preserving the same supported explicit model and wallet/budget gates
modelBillingWho pays for model calls: platform wallet or the user's connected subscription — "platform" · "account"
idleTimeoutSecondsSeconds the session's machine stays awake after a turn ends before it is paused; null = the platform default of 60. Set it when people use apps on the session's exposed ports after the agent finishes
defaultIs this the agent's default session
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnamemetadatabudgetHard spend cap, or null when the session has none. A reached budget pauses the session (402 budget_reached on new work) until the cap is raised above consumed_cost or removed — removal is one-way.
resourcesThe files, GitHub repositories, and read-only memory stores mounted into the session, oldest first
▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequiredworkspaceDefaultsWhat the session started with because its workspace made it a default; everything else it carries was named at creation. Null when it took nothing.
hostedBySellerPresent only when the session runs on its agent's maker's own server instead of a sandbox: what is sent to the session goes to this host. `agentType` and `llm` then name a stand-in that never runs.
▸ Show child attributes▾ Hide child attributes
hostrequiredattachmentsEverything the session started with: its environment, vaults, mounted files and memory stores, and the workspace's always-available skills. The skills of the session's agent are on the agent and are not repeated here.
▸ Show child attributes▾ Hide child attributes
typerequired"environment" · "vault" · "file" · "skill" · "memory_store"
idrequiredThe id of the environment, vault, file, skill or memory store
mountPathrequiredWhere a file or memory store is mounted; null for the other types
sourcerequireddefault = the workspace supplied it; explicit = it was named when the session was created. A memory store on a session created before 2026-10-06 reads as explicit — "default" · "explicit"
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/sessions/{id}writeUpdate title / metadata / model / reasoning effort / billing / budget
llm and reasoningEffort are session settings: they change this session only, never the agent or its other sessions. The model must fit the harness; explicit effort must fit both harness and target model. Inherited effort is normalized for that model. An idle session restarts its engine in place; a running session finishes its turn and applies the change at the next turn (the response is 200 either way). A parked session applies it at its next wake.
idrequiredThe session id
titlemax length 120
metadataidleTimeoutSecondsSeconds this session's machine stays awake after a turn ends before it is paused (60-86400; omitted = the platform default of 60). A paused machine wakes on the next message; apps the agent serves on exposed ports are unreachable while it is paused, so set this to how long people keep using them after the agent finishes; null clears back to the platform default. Applies from the next time the session goes idle
llmSwitch this session's model (a current model for its harness; the agent's model is unchanged). Applies from the next turn
reasoningEffortSession-level reasoning effort; null clears to the agent's setting normalized for the target model. Applies from the next turn. Explicit values must fit both harness and target model — agoragentic_acp: not supported; amp_acp: not supported; auggie: not supported; autohand: not supported; cline: not supported; codebuddy_code: not supported; cortex_code: not supported; corust_agent: not supported; crow_cli: not supported; cursor: not supported; deepagents: not supported; devin: not supported; dimcode: not supported; dirac: not supported; factory_droid: not supported; fast_agent: not supported; gemini: not supported; github_copilot_cli: not supported; glm_acp_agent: not supported; antigravity_acp: not supported; goose: not supported; grok_build: not supported; harn: not supported; junie: not supported; kilo: not supported; kimchi: not supported; minimax_code: not supported; minion_code: not supported; mistral_vibe: not supported; nova: not supported; poolside: not supported; qoder: not supported; qwen_code: not supported; sigit: not supported; stakpak: not supported; vtcode: not supported; code_assistant: not supported; docker_cagent: not supported; kiro: not supported; muse_code: not supported; openhands: not supported; hermes: none/minimal/low/medium/high/xhigh/max/ultra; claude_code: low/medium/high/xhigh/max; codex: none/minimal/low/medium/high/xhigh/max; openclaw: not supported; jev: not supported; pi: off/minimal/low/medium/high/xhigh/max; dsh: not supported; kimi_code: not supported; opencode: none/minimal/low/medium/high/xhigh/max; workspace_acp: not supported; models: claude-haiku-4-5: not supported; gemini-3.8-flash: low/medium/high; gemini-3.5-flash: low/medium/high; glm-5.3: low/high/max; glm-5.3-flash: low/high/max; grok-4.6: low/medium/high; grok-4.7: low/medium/high/xhigh; codex/hermes + gpt-6.1-sol: low/medium/high/xhigh/max — "none" · "off" · "minimal" · "low" · "medium" · "high" · "xhigh" · "max" · "ultra"
subscriptionApiFallbackAfter every subscription account is exhausted, continue on the same model using the paid platform API; wallet and session budget still apply
modelBillingWho pays for model calls; switching restarts the agent's engine in place — "platform" · "account"
budgetChange the spend cap (must be strictly above consumed cost) or null to remove it — removal is one-way
▸ Show child attributes▾ Hide child attributes
typerequiredmax_list_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents as an integer decimal string, e.g. "125" for $1.25 — max length 15
currencyrequiredsessionrequired▸ Show child attributes▾ Hide child attributes
idsess_… identifier
agentIdThe agent id (agent_…)
titlestatusprovisioning = the sandbox is booting or installing the environment's packages (a turn sent meanwhile waits for it); running = a turn is in flight; terminated = archived or the last runtime was destroyed. Use archived for the durable archive receipt — "provisioning" · "idle" · "running" · "terminated"
archivedTrue only after this Session's archive mark was durably written; false for an active Session whose runtime was destroyed
agentTypellmThe model this session runs on (PATCH to change; the agent's model is unchanged)
harnessVersionHarness release the session runs: the one its serving pod booted, the restored checkpoint's for a native-fork handoff, the agent's pin for ACP harnesses, otherwise the current release
reasoningEffortThe model-compatible effort resolved from the session pin, then agent pin. Constrained models use an allowed fallback; no-setting models return null. Unpinned unconstrained models return null for the harness default.
subscriptionApiFallbackOpt-in to paid API continuation after all subscription accounts exhaust, preserving the same supported explicit model and wallet/budget gates
modelBillingWho pays for model calls: platform wallet or the user's connected subscription — "platform" · "account"
idleTimeoutSecondsSeconds the session's machine stays awake after a turn ends before it is paused; null = the platform default of 60. Set it when people use apps on the session's exposed ports after the agent finishes
defaultIs this the agent's default session
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnamemetadatabudgetHard spend cap, or null when the session has none. A reached budget pauses the session (402 budget_reached on new work) until the cap is raised above consumed_cost or removed — removal is one-way.
resourcesThe files, GitHub repositories, and read-only memory stores mounted into the session, oldest first
▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequiredworkspaceDefaultsWhat the session started with because its workspace made it a default; everything else it carries was named at creation. Null when it took nothing.
hostedBySellerPresent only when the session runs on its agent's maker's own server instead of a sandbox: what is sent to the session goes to this host. `agentType` and `llm` then name a stand-in that never runs.
▸ Show child attributes▾ Hide child attributes
hostrequiredattachmentsEverything the session started with: its environment, vaults, mounted files and memory stores, and the workspace's always-available skills. The skills of the session's agent are on the agent and are not repeated here.
▸ Show child attributes▾ Hide child attributes
typerequired"environment" · "vault" · "file" · "skill" · "memory_store"
idrequiredThe id of the environment, vault, file, skill or memory store
mountPathrequiredWhere a file or memory store is mounted; null for the other types
sourcerequireddefault = the workspace supplied it; explicit = it was named when the session was created. A memory store on a session created before 2026-10-06 reads as explicit — "default" · "explicit"
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"title":"Signups digest","metadata":{"team":"growth"},"llm":"claude-sonnet-5","reasoningEffort":"high"}'/sessions/{id}writeRetire a Session and tear down its runtime
Marks the Session deleted and removes operational bindings; durable transcripts and accounting records are retained. GET Session answers 404 afterward. Active execution must stop before cleanup. Works on idle and archived Sessions.
idrequiredThe session id
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Who may use the session, and what you are to it
Members of the session's workspace may read and prompt a workspace session; a private session is the owner's alone. People whose verified email is listed may read its message history from any workspace. Viewer emails are returned to the owner only.
idrequiredThe session id
session_idrequiredtitlerequiredagent_typerequiredllmrequiredvisibilityrequired"workspace" · "private"
accessrequired"owner" · "member" · "viewer"
ownerrequired▸ Show child attributes▾ Hide child attributes
idnameemailworkspacerequired▸ Show child attributes▾ Hide child attributes
slugnamepersonalviewersrequired▸ Show child attributes▾ Hide child attributes
emailadded_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/access' \
-H "Authorization: Bearer ast_..."/sessions/{id}/accesswrite, ownerMake the session private or workspace-visible, and edit its viewers
idrequiredThe session id
visibility"workspace" · "private"
add_viewersremove_viewerssession_idrequiredtitlerequiredagent_typerequiredllmrequiredvisibilityrequired"workspace" · "private"
accessrequired"owner" · "member" · "viewer"
ownerrequired▸ Show child attributes▾ Hide child attributes
idnameemailworkspacerequired▸ Show child attributes▾ Hide child attributes
slugnamepersonalviewersrequired▸ Show child attributes▾ Hide child attributes
emailadded_at{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/access \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"visibility":"private","add_viewers":["reviewer@acme.com"]}'Read the conversation a share link opens, as any signed-in caller holding the link
Answers the session as its reader sees it and one page of people's turns and the agent's replies, text only (no attachments, tool calls, system messages or marks), oldest first, with the same opaque cursor as /sessions/{id}/events. Works for view-only and guest links. Unknown, rotated, disabled and deleted links all answer 404 not_found; reads are rate-limited per token (429 rate_limited with Retry-After). Needs a token with read scope from any workspace; the link is the grant, so the caller need not belong to the session's workspace.
tokenrequiredcursorcursor from the previous page
limitsessionrequired▸ Show child attributes▾ Hide child attributes
idrequiredtitlerequiredagent_typerequiredownerrequired▸ Show child attributes▾ Hide child attributes
nameworkspacerequired▸ Show child attributes▾ Hide child attributes
nameeventsrequireduser.message and agent.message events, text parts only
cursorrequiredhasMorerequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/links/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0/events' \
-H "Authorization: Bearer ast_..."Archive the session — irreversible; blocks new events, history stays readable
Durably marks archived=true and sets status to terminated, tears down the pod and stored context, and refuses further messages (400 session_archived); the record and its events remain readable. A running session is refused with 400 session_running: interrupt and wait for idle first. A changed active Session whose archive mark did not commit returns 409 session_changed. Idempotent when another request already archived it.
idrequiredThe session id
sessionrequired▸ Show child attributes▾ Hide child attributes
idsess_… identifier
agentIdThe agent id (agent_…)
titlestatusprovisioning = the sandbox is booting or installing the environment's packages (a turn sent meanwhile waits for it); running = a turn is in flight; terminated = archived or the last runtime was destroyed. Use archived for the durable archive receipt — "provisioning" · "idle" · "running" · "terminated"
archivedTrue only after this Session's archive mark was durably written; false for an active Session whose runtime was destroyed
agentTypellmThe model this session runs on (PATCH to change; the agent's model is unchanged)
harnessVersionHarness release the session runs: the one its serving pod booted, the restored checkpoint's for a native-fork handoff, the agent's pin for ACP harnesses, otherwise the current release
reasoningEffortThe model-compatible effort resolved from the session pin, then agent pin. Constrained models use an allowed fallback; no-setting models return null. Unpinned unconstrained models return null for the harness default.
subscriptionApiFallbackOpt-in to paid API continuation after all subscription accounts exhaust, preserving the same supported explicit model and wallet/budget gates
modelBillingWho pays for model calls: platform wallet or the user's connected subscription — "platform" · "account"
idleTimeoutSecondsSeconds the session's machine stays awake after a turn ends before it is paused; null = the platform default of 60. Set it when people use apps on the session's exposed ports after the agent finishes
defaultIs this the agent's default session
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnamemetadatabudgetHard spend cap, or null when the session has none. A reached budget pauses the session (402 budget_reached on new work) until the cap is raised above consumed_cost or removed — removal is one-way.
resourcesThe files, GitHub repositories, and read-only memory stores mounted into the session, oldest first
▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequiredworkspaceDefaultsWhat the session started with because its workspace made it a default; everything else it carries was named at creation. Null when it took nothing.
hostedBySellerPresent only when the session runs on its agent's maker's own server instead of a sandbox: what is sent to the session goes to this host. `agentType` and `llm` then name a stand-in that never runs.
▸ Show child attributes▾ Hide child attributes
hostrequiredattachmentsEverything the session started with: its environment, vaults, mounted files and memory stores, and the workspace's always-available skills. The skills of the session's agent are on the agent and are not repeated here.
▸ Show child attributes▾ Hide child attributes
typerequired"environment" · "vault" · "file" · "skill" · "memory_store"
idrequiredThe id of the environment, vault, file, skill or memory store
mountPathrequiredWhere a file or memory store is mounted; null for the other types
sourcerequireddefault = the workspace supplied it; explicit = it was named when the session was created. A memory store on a session created before 2026-10-06 reads as explicit — "default" · "explicit"
createdAtISO 8601
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/archive \
-H "Authorization: Bearer ast_..."The session's billed usage, newest first
Totals plus one row per billed event — model turns, runtime, capability and connector calls — with the token breakdown, list and billed dollars, basis and duration. `limit` (default 50) pages with an opaque `cursor`; keep following `cursor` until it is null. A row whose `coveredBy` is `subscription` ran on the reader's own Claude or ChatGPT plan: `listCostUsd` is what it was worth, `billedCostUsd` is zero. Dollar amounts here are numbers in USD, not the `{amount, currency}` cents object used elsewhere.
idrequiredThe session id
cursorA cursor from a previous page
limit1–500, default 50
sessionrequiredtotalsrequiredSummed over the whole session, not just this page. `durationComplete` is false while a turn is still running. `tokenCostsUsd` is only present when every model charge carried its original breakdown.
▸ Show child attributes▾ Hide child attributes
listCostUsdbilledCostUsdinputTokensoutputTokenscachedInputTokenscacheCreationTokensmodelBilledCostUsdruntimeCostUsdcapabilityCallCostUsdconnectorCallCostUsdturnsdurationMsdurationCompletecoveredBy"subscription" · null
tokenCostsUsdentriesrequired▸ Show child attributes▾ Hide child attributes
kindrequiredatrequiredlistCostUsdbilledCostUsdrequiredcoveredByWhy a metered turn was booked at $0, when that is known — "subscription" · null
modelproviderbasisdurationMsinterruptedtokensrequired▸ Show child attributes▾ Hide child attributes
inputoutputcachedInputcacheCreationbudgetThe session's budget summary — the same shape as `budget` on Session — or null when it has none
cursorrequiredPass as ?cursor= for the next page; null on the last
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/usage' \
-H "Authorization: Bearer ast_..."List session-level policy rules
idrequiredThe session id
rules▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/policies' \
-H "Authorization: Bearer ast_..."Create a session-level policy rule (owner only)
idrequiredThe session id
option 1▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired▸ Show child attributes▾ Hide child attributes
actionrequired"allow" · "ask" · "deny"
matchermax length 255
commandPatternsmax length 500
option 2▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired▸ Show child attributes▾ Hide child attributes
warnUsdMicroshardCapUsdMicrosrequiredoption 3▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired▸ Show child attributes▾ Hide child attributes
limitPerSessionrequiredoption 4▸ Show child attributes▾ Hide child attributes
namerequiredmax length 128
enableddefault: true
positiondefault: 0
kindrequiredconfigrequired"allow" · "ask" · "deny"
rule▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/policies \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"name":"Spend cap","kind":"SPEND_CAP","config":{"hardCapUsdMicros":5000000,"warnUsdMicros":4000000}}'Get a session-level policy rule
idrequiredThe session id
ruleIdrequiredrule▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/policies/cmtb5p0l3r8w2k01s6x7n9q4' \
-H "Authorization: Bearer ast_..."Update a session-level policy rule (owner only)
idrequiredThe session id
ruleIdrequirednamemax length 128
enabledpositionconfig▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
actionrequired"allow" · "ask" · "deny"
matchermax length 255
commandPatternsmax length 500
option 2▸ Show child attributes▾ Hide child attributes
warnUsdMicroshardCapUsdMicrosrequiredoption 3▸ Show child attributes▾ Hide child attributes
limitPerSessionrequiredoption 4"allow" · "ask" · "deny"
rule▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/policies/cmtb5p0l3r8w2k01s6x7n9q4 \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"config":{"hardCapUsdMicros":10000000,"warnUsdMicros":8000000}}'Delete a session-level policy rule (owner only)
idrequiredThe session id
ruleIdrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/policies/cmtb5p0l3r8w2k01s6x7n9q4 \
-H "Authorization: Bearer ast_..."Effective merged policy for a session across all layers
Returns all policy rules for workspace → agent → session, with a note when native tool policies prevent an unsupported runtime from starting.
idrequiredThe session id
rules▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredkindrequired"TOOL_CALL" · "SPEND_CAP" · "CALL_COUNT" · "CAPABILITY"
enabledrequiredconfigrequiredlayerrequired"workspace" · "agent" · "session"
positionrequiredcreatedAtrequiredupdatedAtrequirednote{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/effective-policy' \
-H "Authorization: Bearer ast_..."Deprecated: the address of the web app running inside the session's pod
Replaced by `PUT /sessions/{id}/ports/{port}` and `POST …/ports/{port}/grants`; kept for one release while the consumer app moves. Minted once per session and stable afterwards. `port` is what the app inside the pod listens on — 1024–65535, defaulting to the studio's own port. An archived session answers 400 session_archived.
idrequiredThe session id
portOmitted = the studio's default port
urlrequiredhttps://studio-<token>.agentsky.dev — the token is the whole address
portrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/studio \
-H "Authorization: Bearer ast_..."The session's exposed ports, oldest first
Every local server the agent runs inside the pod that has been exposed on an origin of its own.
idrequiredThe session id
portsrequired▸ Show child attributes▾ Hide child attributes
portrequiredWhat the app listens on inside the pod
idrequiredNames the origin; not a credential
urlrequiredhttps://app-<id>.agentsky.dev/ — stable for the port's life
visibilityrequired"private" · "public"
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/ports' \
-H "Authorization: Bearer ast_..."Expose a port the agent's local server listens on
Create-or-get: the port gets a stable origin `https://app-<id>.agentsky.dev/` relayed to the pod (HTTP and WebSocket) while the pod runs; calling again returns the same record, and a `visibility` in the body replaces the stored one in place. `port` is 1024–65535 and never the pod's own (400 invalid_request). A private port (the default) admits a browser only through an entry link from `POST …/grants`; a public port admits anyone with the address. A parked pod answers a paused page and is never woken by a visit. An archived session answers 400 session_archived.
idrequiredThe session id
portrequiredThe port the app listens on inside the pod
visibilityOmitted = keep the stored value (private for a new port) — "private" · "public"
portrequiredWhat the app listens on inside the pod
idrequiredNames the origin; not a credential
urlrequiredhttps://app-<id>.agentsky.dev/ — stable for the port's life
visibilityrequired"private" · "public"
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/ports/port \
-H "Authorization: Bearer ast_..."One exposed port
idrequiredThe session id
portrequiredThe port the app listens on inside the pod
portrequiredWhat the app listens on inside the pod
idrequiredNames the origin; not a credential
urlrequiredhttps://app-<id>.agentsky.dev/ — stable for the port's life
visibilityrequired"private" · "public"
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/ports/port' \
-H "Authorization: Bearer ast_..."Stop exposing a port
The origin answers 404 from then on (within a few seconds); browsers that had entered are signed out with it.
idrequiredThe session id
portrequiredThe port the app listens on inside the pod
Revoked
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/ports/port \
-H "Authorization: Bearer ast_..."An entry link for an exposed port
For a private port: a single-use link, good for a minute, that signs the browser opening it in to the port's origin (a cookie that lives twelve hours) and lands on `path`; minting again supersedes the previous unused link. For a public port: the plain address. An archived session answers 400 session_archived.
idrequiredThe session id
portrequiredThe port the app listens on inside the pod
pathWhere on the app to land after entering; a path on the port's origin, default /
urlrequiredA private port: a single-use entry link, good for a minute; a public port: the plain address
expires_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/ports/port/grants \
-H "Authorization: Bearer ast_..."List the session's resources, oldest first
`limit` (1–1000) pages the list with an opaque `page` cursor; omitted lists every resource in one answer.
idrequiredThe session id (sess_…)
limitpageA next_page cursor
datarequiredOldest first
▸ Show child attributes▾ Hide child attributes
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequirednext_pagerequiredPass back as ?page= for the next page; null when `limit` was omitted or the list ended
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/resources' \
-H "Authorization: Bearer ast_..."{
"data": [
{
"type": "file",
"id": "sesrsc_cmtc1a2b",
"file_id": "file_cmtc1a2c",
"mount_path": "/workspace/data/signups.csv",
"created_at": "2026-09-11T18:00:00.000Z",
"updated_at": "2026-09-11T18:00:00.000Z"
},
{
"type": "github_repository",
"id": "sesrsc_cmtc1a2d",
"url": "https://github.com/acme/growth",
"mount_path": "/workspace/growth",
"checkout": {
"type": "branch",
"name": "main"
},
"created_at": "2026-09-11T18:00:00.000Z",
"updated_at": "2026-09-11T18:00:00.000Z"
},
{
"type": "memory_store",
"id": "smsr_cmtc1a2e",
"memory_store_id": "memstore_cmtb9x4p",
"mount_path": "/mnt/memory/memstore_cmtb9x4p",
"access": "read_only",
"created_at": "2026-09-11T18:00:00.000Z",
"updated_at": "2026-09-11T18:00:00.000Z"
}
],
"next_page": null
}Add a file to a running session
Files only — repositories and memory stores can only be attached at session create. The file is copied read-only to `/workspace<mount_path>` before the session's next turn; `mount_path` follows the create rules (rooted under /workspace, no escape, no overlap with another resource). 400 too_many_resources past 500 per session; 400 session_archived on an archived session.
idrequiredThe session id (sess_…)
type: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredmax length 128
mount_pathmax length 4096
type: "github_repository"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredmax length 2048
authorization_tokenmax length 1024
checkout▸ Show child attributes▾ Hide child attributes
type: "branch"▸ Show child attributes▾ Hide child attributes
typerequirednamerequiredmax length 255
type: "commit"▸ Show child attributes▾ Hide child attributes
typerequiredsharequiredmax length 64
mount_pathmax length 4096
type: "memory_store"▸ Show child attributes▾ Hide child attributes
typerequiredmemory_store_idrequiredmax length 255
accessrequired"read_only" · "read_write"
instructionsmax length 4096
mount_pathmax length 4096
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/resources \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"type":"file","file_id":"file_cmtb9x4p","mount_path":"/data/signups.csv"}'{
"type": "file",
"id": "sesrsc_cmtc1a2b",
"file_id": "file_cmtc1a2c",
"mount_path": "/workspace/data/signups.csv",
"created_at": "2026-09-11T18:00:00.000Z",
"updated_at": "2026-09-11T18:00:00.000Z"
}One resource
idrequiredThe session id (sess_…)
ridrequiredThe resource id (sesrsc_… or smsr_…)
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/resources/sesrsc_cmtc1a2d' \
-H "Authorization: Bearer ast_..."Rotate a repository's token
Only `github_repository` resources accept an update, and the token is the only field: it is re-encrypted and the session's egress policy is recompiled and pushed to its live pod — nothing changes inside the sandbox. A file or memory store answers 400. A token that conflicts with another secret's Authorization header on github.com answers 400 egress_header_conflict.
idrequiredThe session id (sess_…)
ridrequiredThe resource id (sesrsc_… or smsr_…)
authorization_tokenrequiredmax length 1024
option 1▸ Show child attributes▾ Hide child attributes
typerequired"file"
idrequiredsesrsc_…
file_idrequiredThe per-session copy (file_…), read-only at mount_path
mount_pathrequiredAbsolute, under /workspace
created_atrequiredupdated_atrequiredoption 2▸ Show child attributes▾ Hide child attributes
typerequired"github_repository"
idrequiredsesrsc_…
urlrequiredhttps://github.com/{owner}/{repo}
mount_pathrequiredAbsolute, under /workspace; the clone's root
checkout{type:"branch", name} or {type:"commit", sha}; absent = the default branch
▸ Show child attributes▾ Hide child attributes
type"branch" · "commit"
nameshacreated_atrequiredupdated_atrequiredoption 3▸ Show child attributes▾ Hide child attributes
typerequired"memory_store"
idrequiredsmsr_…
memory_store_idrequiredmemstore_…
mount_pathrequiredAbsolute, under /mnt/memory
accessrequired"read_only" · "read_write"
instructionsOptional per-session guidance
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/resources/sesrsc_cmtc1a2d \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"authorization_token":"github_pat_…"}'Remove a file from the session
Files only — the resource and its per-session copy are deleted and the pod unlinks the file before the session's next turn. A repository or memory store answers 400: neither can be removed mid-session.
idrequiredThe session id (sess_…)
ridrequiredThe resource id (sesrsc_… or smsr_…)
typerequired"session_resource_deleted"
idrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/resources/sesrsc_cmtc1a2d \
-H "Authorization: Bearer ast_..."{
"type": "session_resource_deleted",
"id": "sesrsc_cmtc1a2b"
}Conversation
Deprecated — use POST /sessions/{id}/events
The legacy input shape ({parts}); accepted for one release and translated to a single user.message, then 410. Optional Idempotency-Key header dedupes retries.
idrequiredThe session id
partsrequired▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredtextdefault: ""
stream_idstream_indextype: "reasoning"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredtextdefault: ""
redacteddefault: false
stream_idstream_indextype: "tool_call"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcall_idrequiredtool_namerequiredargsdefault: {}
args_partialtype: "tool_result"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcall_idrequiredtool_namerequiredstatus"ok" · "error" — default: "ok"
resultdefault: {}
type: "file"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequirednamerequiredmedia_typerequireduridatasize_bytestype: "image"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredmedia_typerequireduridataaltwidthheighttype: "video"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredmedia_typerequireduridataaltwidthheightduration_mssize_bytesthumbnail_uritype: "status"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredlevelrequired"thinking" · "working" · "waiting" · "idle" · "done"
texttype: "error"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcoderequiredmessagerequiredretryabledefault: false
Accepted — body is {}; output arrives on the stream
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/messages \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"parts":[{"type":"text","index":0,"text":"Summarize the signups from today"}]}'{}Send events — the one input: user.message, user.interrupt, system.message
The conversation plane (edge-routed to the chat-proxy). Body {events: [...]} (1–50), optionally requireIdle: true for one user.message (and optional trailing system.message). Exclusive admission refuses a busy session with 409 before persisting or delivering the message; a successful echo's user id names the admitted run. Its admission field is created only when this POST committed the exclusive input; an idempotent replay returns replayed. This field is not part of history or SSE. This is a Session admission receipt, not proof that another client's earlier queued joined input has finished on the Pod. Ordinary sends may join an open run. validated all-or-nothing. A user.message carries content blocks: text, image and document with base64 / url / file sources (inline base64 ≤ 20 MiB per request; larger content goes through POST /files). A system.message (text only) must be last and follow the user.message it accompanies: privileged context for that turn and, through the agent's transcript, later turns. user.interrupt stops the in-flight turn; with mode: "save" it instead asks the run to start no new work, save what it has (files plus a progress note in the working directory) and end its turn with a reply listing what was saved, and stops it only if it is still running after a 10 minute grace window (echo status saving, or no_turn when nothing is running). A later user.message continues in the same session. Every event echoes back in the history shape with a stable id; sources are echoed as file sources naming per-session copies (never base64). Optional Idempotency-Key header: a replay returns the original echo. 402 insufficient_credits / budget_reached, 503 egress_policy_failed, 400 session_archived refuse the whole request before any row is written.
idrequiredThe session id
eventsrequired▸ Show child attributes▾ Hide child attributes
type: "user.message"▸ Show child attributes▾ Hide child attributes
typerequiredcontentrequired▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "image"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtype: "document"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "text"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typedefault: "text/plain"
datarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtitlecontextinteraction_mode"plan" · "build"
type: "system.message"▸ Show child attributes▾ Hide child attributes
typerequiredcontentrequired▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "user.interrupt"▸ Show child attributes▾ Hide child attributes
typerequiredmode"immediate" · "save"
requireIdleOK — one echo per event, in order
datarequiredOne echo per event, in order, in the events-history shape
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/events \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"requireIdle":true,"events":[{"type":"user.message","content":[{"type":"text","text":"What is in this screenshot?"},{"type":"image","source":{"type":"file","file_id":"file_cmtb9x4p"}}]},{"type":"system.message","content":[{"type":"text","text":"Answer in one paragraph."}]}]}'{
"data": [
{
"id": "api-user-3f2c…",
"type": "user.message",
"admission": "created",
"sessionId": "sess_cmtb7q2j",
"agentId": "agent_cmtb2f0a8m9k7x51q4ez6r0d",
"at": "2026-09-10T18:00:00.000Z",
"content": [
{
"type": "text",
"text": "What is in this screenshot?"
},
{
"type": "image",
"source": {
"type": "file",
"file_id": "file_cmtb9y1q"
}
}
]
},
{
"id": "api-user-3f2c…#system",
"type": "system.message",
"sessionId": "sess_cmtb7q2j",
"agentId": "agent_cmtb2f0a8m9k7x51q4ez6r0d",
"at": "2026-09-10T18:00:00.000Z",
"content": [
{
"type": "text",
"text": "Answer in one paragraph."
}
]
}
]
}The event history — the same event objects the stream delivers
The session's history, one event per message: user.message and system.message (with content), agent.message (with parts), user.interrupt, and the turn marks session.status_running, session.status_idle (stop_reason.type is end_turn, retries_exhausted, provider_lost or budget_reached) and session.error. agent.reasoning, agent.tool_use, agent.tool_result and agent.status appear on the live stream only, not in history. Oldest-first with an opaque numeric cursor. Reconnect = open the stream, list events, dedupe by event id. types[] filters (e.g. types[]=user.message&types[]=agent.message is the transcript view).
idrequiredThe session id
cursorlimittypes[]eventsrequiredOldest-first
▸ Show child attributes▾ Hide child attributes
idrequiredStable event id — the dedupe key across stream ∪ events
typerequireduser.message · system.message (both history only — never on the live stream; they carry `content`) · agent.message · agent.reasoning · agent.tool_use · agent.tool_result · agent.status · user.interrupt · session.status_running · session.status_idle · session.error · session.status_terminated · session.deleted
sessionIdrequiredagentIdThe agent id (agent_…)
atISO 8601
messageIdagent.message
partsagent.message
▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredtextdefault: ""
stream_idstream_indextype: "reasoning"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredtextdefault: ""
redacteddefault: false
stream_idstream_indextype: "tool_call"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcall_idrequiredtool_namerequiredargsdefault: {}
args_partialtype: "tool_result"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcall_idrequiredtool_namerequiredstatus"ok" · "error" — default: "ok"
resultdefault: {}
type: "file"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequirednamerequiredmedia_typerequireduridatasize_bytestype: "image"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredmedia_typerequireduridataaltwidthheighttype: "video"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredmedia_typerequireduridataaltwidthheightduration_mssize_bytesthumbnail_uritype: "status"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredlevelrequired"thinking" · "working" · "waiting" · "idle" · "done"
texttype: "error"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcoderequiredmessagerequiredretryabledefault: false
textagent.message — parts flattened to plain text
contentuser.message / system.message — the CMA content blocks as sent (text · image · document); every image/document source is a `file` source naming a per-session copy readable through GET /files/{file_id}/content
partreasoning / tool_use / tool_result / status events
▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredtextdefault: ""
stream_idstream_indextype: "reasoning"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredtextdefault: ""
redacteddefault: false
stream_idstream_indextype: "tool_call"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcall_idrequiredtool_namerequiredargsdefault: {}
args_partialtype: "tool_result"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcall_idrequiredtool_namerequiredstatus"ok" · "error" — default: "ok"
resultdefault: {}
type: "file"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequirednamerequiredmedia_typerequireduridatasize_bytestype: "image"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredmedia_typerequireduridataaltwidthheighttype: "video"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredmedia_typerequireduridataaltwidthheightduration_mssize_bytesthumbnail_uritype: "status"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredlevelrequired"thinking" · "working" · "waiting" · "idle" · "done"
texttype: "error"▸ Show child attributes▾ Hide child attributes
indexrequiredtyperequiredcoderequiredmessagerequiredretryabledefault: false
stop_reasonsession.status_idle — discriminate on type; never break on bare idle
▸ Show child attributes▾ Hide child attributes
type"end_turn" (also after an interrupt) | "retries_exhausted" (preceded by an exhausted engine error) | "provider_lost" (confirmed runtime Pod loss, preceded by an exhausted session.error) | "budget_reached"; more reserved
errorsession.error — the stream stays open; a session.status_idle follows once the turn is over
▸ Show child attributes▾ Hide child attributes
typee.g. "pod_unavailable"
messageretry_status"retrying" (the turn continues) | "exhausted" (the turn is over)
byuser.interrupt — who requested the interrupt
modeuser.interrupt — present on a save interrupt: the run was asked to save its work and end itself — "save"
deadline_atuser.interrupt with mode save — when the run is stopped if it has not ended by then
causeuser.interrupt — present when the platform stopped a run whose save grace window ran out — "save_timeout"
actoruser.message only, in history and in the send echo: who sent it, present only when that was not the session's owner
▸ Show child attributes▾ Hide child attributes
idnamecursorrequiredPass back as ?cursor= for the next page; null when the session has no events
hasMorerequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/events' \
-H "Authorization: Bearer ast_..."{
"events": [
{
"id": "api-user-8c41f0…#idle",
"type": "session.status_idle",
"sessionId": "sess-8c41f0…",
"agent": "agent_cmtb2f0a8m9k7x51q4ez6r0d",
"stop_reason": {
"type": "end_turn"
}
}
],
"cursor": "42",
"hasMore": false
}The standing event stream (SSE)
text/event-stream, stays open across turns. If a run is in flight when the stream opens, its status marks so far (session.status_running, session.error, user.interrupt) are replayed from history under their own ids and timestamps, so a stream opened mid-run still sees the boundary its duration is measured from; a run that has already ended is not replayed — read it from the event history. Everything else is live. Dedupe by event id. Events: agent.message, agent.reasoning, agent.tool_use, agent.tool_result, agent.status, session.status_running, session.status_idle (carries stop_reason — never break on bare idle), session.error (the stream stays open; an idle follows), user.interrupt, session.status_terminated (terminal), session.deleted (terminal). User messages are not sent on the live stream — they appear in the event history only. Reconnect = reopen + list events + dedupe by event id.
idrequiredThe session id
SSE stream
{ "error": { "code", "message" } } — see the error table above.curl -N 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/stream' \
-H "Authorization: Bearer ast_..."Abort the in-flight turn
idrequiredThe session id
statusrequiredno_turn = nothing in flight; otherwise user.interrupt echoes on the stream and the pod's session.status_idle follows — "interrupting" · "no_turn"
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/interrupt \
-H "Authorization: Bearer ast_..."{
"status": "interrupting"
}Goals
The session's standing goal, or null
A goal is an objective the session works toward on its own: after each turn settles, the platform grades the work against the goal's criteria and either takes another turn or stops. At most one goal per session.
idrequiredThe session id
goalrequired▸ Show child attributes▾ Hide child attributes
idrequiredgoal_…
sessionrequiredsess_…
objectiverequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredStable within the goal, e.g. c1
textrequiredcommandPresent when a shell command decides this criterion: it runs in the session's workspace after each iteration, and exit 0 means met. The grader cannot overturn it.
criteria_sourcerequiredWhether the caller supplied the criteria or the platform derived them from the objective — "user" · "derived"
statusrequired"active" · "paused" · "completed" · "stopped"
stop_reasonrequiredWhy a stopped goal stopped; null in every other status — "failed" · "max_iterations" · "spend_budget" · "token_budget" · "time_budget" · "no_progress" · "cleared" · "session_ended" · null
iterationrequiredSelf-started turns taken so far
max_iterationsrequiredmax_spendrequired▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
consumed_spendrequiredWhat this session has spent since the goal started
▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
max_tokensrequiredToken ceiling for this goal; null = none
consumed_tokensrequiredUncached input plus output tokens over the session's metered model calls since the goal started, grading included. Calls on the session's own model subscription are not metered and not counted.
deadline_atrequiredlast_evaluationrequiredcreated_atrequiredupdated_atrequiredcompleted_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/goal' \
-H "Authorization: Bearer ast_..."/sessions/{id}/goalwriteSet the session's goal, replacing any existing one
Work starts immediately — no separate message is needed, and sending one is not how a goal begins. Criteria are optional: omitted, they are derived from the objective so completion is always judged against an explicit list, which the response returns and PATCH can correct. A criterion given as { text, command } is decided by running the command in the session's workspace (exit 0 = met) instead of by the grader. A person's message always outranks the loop: while a turn is running the goal waits, and takes the turn after it. Grading is a model call billed to the session; with an empty wallet deriving criteria is refused with 402 insufficient_credits. Setting a goal stops the run the goal it replaces had started.
idrequiredThe session id
objectiverequiredWhat the agent should work toward, in the user's words — max length 4000
criteriaIndependently checkable requirements; omitted = derived from the objective
▸ Show child attributes▾ Hide child attributes
option 1max length 500
option 2▸ Show child attributes▾ Hide child attributes
textrequiredWhat the criterion requires, in words — max length 500
commandShell command run in the session's workspace; exit 0 means the criterion is met — max length 1000
max_iterationsSelf-started turns this goal may take before it stops. Omitted = 20; null = no iteration ceiling
max_no_progressConsecutive turns without a tool call before stopping. Omitted = 3; null = no no-progress ceiling
max_spendSpend ceiling for this goal; null = none
▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents as an integer decimal string, e.g. "500" for $5.00 — max length 15
currencyrequiredmax_tokensmax_duration_minutesWall-clock ceiling from the goal's start, extended by any time it spends paused
goalrequired▸ Show child attributes▾ Hide child attributes
idrequiredgoal_…
sessionrequiredsess_…
objectiverequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredStable within the goal, e.g. c1
textrequiredcommandPresent when a shell command decides this criterion: it runs in the session's workspace after each iteration, and exit 0 means met. The grader cannot overturn it.
criteria_sourcerequiredWhether the caller supplied the criteria or the platform derived them from the objective — "user" · "derived"
statusrequired"active" · "paused" · "completed" · "stopped"
stop_reasonrequiredWhy a stopped goal stopped; null in every other status — "failed" · "max_iterations" · "spend_budget" · "token_budget" · "time_budget" · "no_progress" · "cleared" · "session_ended" · null
iterationrequiredSelf-started turns taken so far
max_iterationsrequiredmax_spendrequired▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
consumed_spendrequiredWhat this session has spent since the goal started
▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
max_tokensrequiredToken ceiling for this goal; null = none
consumed_tokensrequiredUncached input plus output tokens over the session's metered model calls since the goal started, grading included. Calls on the session's own model subscription are not metered and not counted.
deadline_atrequiredlast_evaluationrequired▸ Show child attributes▾ Hide child attributes
resultrequired"satisfied" · "needs_revision" · "failed"
explanationrequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredmetrequiredreasonrequiredjudged_byWhat decided this criterion on this iteration — "grader" · "command"
iterationrequiredatrequiredcreated_atrequiredupdated_atrequiredcompleted_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/goal \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"objective":"Get the failing integration tests in packages/api passing without weakening them.","criteria":[{"text":"The integration tests pass","command":"cd packages/api && npm test"},"No test assertion was deleted, skipped, or loosened","The fix is in source, not in the tests"],"max_iterations":15,"max_spend":{"amount":"500","currency":"USD"},"max_tokens":2000000}'/sessions/{id}/goalwriteEdit the goal in place
A course correction for an active or paused goal, not a restart: the iteration count and spend already consumed carry over. Editing criteria marks them as the caller's. A completed or stopped goal returns 409; POST a new goal to start another outcome.
idrequiredThe session id
objectivemax length 4000
criteria▸ Show child attributes▾ Hide child attributes
option 1max length 500
option 2▸ Show child attributes▾ Hide child attributes
textrequiredWhat the criterion requires, in words — max length 500
commandShell command run in the session's workspace; exit 0 means the criterion is met — max length 1000
max_iterationsmax_no_progressmax_spend▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents as an integer decimal string, e.g. "500" for $5.00 — max length 15
currencyrequiredmax_tokensmax_duration_minutesgoalrequired▸ Show child attributes▾ Hide child attributes
idrequiredgoal_…
sessionrequiredsess_…
objectiverequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredStable within the goal, e.g. c1
textrequiredcommandPresent when a shell command decides this criterion: it runs in the session's workspace after each iteration, and exit 0 means met. The grader cannot overturn it.
criteria_sourcerequiredWhether the caller supplied the criteria or the platform derived them from the objective — "user" · "derived"
statusrequired"active" · "paused" · "completed" · "stopped"
stop_reasonrequiredWhy a stopped goal stopped; null in every other status — "failed" · "max_iterations" · "spend_budget" · "token_budget" · "time_budget" · "no_progress" · "cleared" · "session_ended" · null
iterationrequiredSelf-started turns taken so far
max_iterationsrequiredmax_spendrequired▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
consumed_spendrequiredWhat this session has spent since the goal started
▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
max_tokensrequiredToken ceiling for this goal; null = none
consumed_tokensrequiredUncached input plus output tokens over the session's metered model calls since the goal started, grading included. Calls on the session's own model subscription are not metered and not counted.
deadline_atrequiredlast_evaluationrequired▸ Show child attributes▾ Hide child attributes
resultrequired"satisfied" · "needs_revision" · "failed"
explanationrequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredmetrequiredreasonrequiredjudged_byWhat decided this criterion on this iteration — "grader" · "command"
iterationrequiredatrequiredcreated_atrequiredupdated_atrequiredcompleted_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/goal \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"criteria":[{"text":"The integration tests pass","command":"cd packages/api && npm test"},"No test assertion was deleted, skipped, or loosened"]}'/sessions/{id}/goalwriteClear the goal
Stops the loop for good with stop_reason "cleared", and interrupts the run the goal itself started if one is going. The record stays readable so the session can still report what it was working on; setting a new goal replaces it.
idrequiredThe session id
goalrequired▸ Show child attributes▾ Hide child attributes
idrequiredgoal_…
sessionrequiredsess_…
objectiverequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredStable within the goal, e.g. c1
textrequiredcommandPresent when a shell command decides this criterion: it runs in the session's workspace after each iteration, and exit 0 means met. The grader cannot overturn it.
criteria_sourcerequiredWhether the caller supplied the criteria or the platform derived them from the objective — "user" · "derived"
statusrequired"active" · "paused" · "completed" · "stopped"
stop_reasonrequiredWhy a stopped goal stopped; null in every other status — "failed" · "max_iterations" · "spend_budget" · "token_budget" · "time_budget" · "no_progress" · "cleared" · "session_ended" · null
iterationrequiredSelf-started turns taken so far
max_iterationsrequiredmax_spendrequired▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
consumed_spendrequiredWhat this session has spent since the goal started
▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
max_tokensrequiredToken ceiling for this goal; null = none
consumed_tokensrequiredUncached input plus output tokens over the session's metered model calls since the goal started, grading included. Calls on the session's own model subscription are not metered and not counted.
deadline_atrequiredlast_evaluationrequired▸ Show child attributes▾ Hide child attributes
resultrequired"satisfied" · "needs_revision" · "failed"
explanationrequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredmetrequiredreasonrequiredjudged_byWhat decided this criterion on this iteration — "grader" · "command"
iterationrequiredatrequiredcreated_atrequiredupdated_atrequiredcompleted_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/goal \
-H "Authorization: Bearer ast_..."Stop driving the goal
Stops taking turns and interrupts the run the goal itself started, if one is going. A run a person started is left to finish; POST /sessions/{id}/interrupt stops that. Refused with 409 invalid_state unless the goal is active.
idrequiredThe session id
goalrequired▸ Show child attributes▾ Hide child attributes
idrequiredgoal_…
sessionrequiredsess_…
objectiverequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredStable within the goal, e.g. c1
textrequiredcommandPresent when a shell command decides this criterion: it runs in the session's workspace after each iteration, and exit 0 means met. The grader cannot overturn it.
criteria_sourcerequiredWhether the caller supplied the criteria or the platform derived them from the objective — "user" · "derived"
statusrequired"active" · "paused" · "completed" · "stopped"
stop_reasonrequiredWhy a stopped goal stopped; null in every other status — "failed" · "max_iterations" · "spend_budget" · "token_budget" · "time_budget" · "no_progress" · "cleared" · "session_ended" · null
iterationrequiredSelf-started turns taken so far
max_iterationsrequiredmax_spendrequired▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
consumed_spendrequiredWhat this session has spent since the goal started
▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
max_tokensrequiredToken ceiling for this goal; null = none
consumed_tokensrequiredUncached input plus output tokens over the session's metered model calls since the goal started, grading included. Calls on the session's own model subscription are not metered and not counted.
deadline_atrequiredlast_evaluationrequired▸ Show child attributes▾ Hide child attributes
resultrequired"satisfied" · "needs_revision" · "failed"
explanationrequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredmetrequiredreasonrequiredjudged_byWhat decided this criterion on this iteration — "grader" · "command"
iterationrequiredatrequiredcreated_atrequiredupdated_atrequiredcompleted_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/goal/pause \
-H "Authorization: Bearer ast_..."Drive the goal again
Any wall-clock deadline moves out by the time the pause consumed. Refused with 409 invalid_state unless the goal is paused.
idrequiredThe session id
goalrequired▸ Show child attributes▾ Hide child attributes
idrequiredgoal_…
sessionrequiredsess_…
objectiverequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredStable within the goal, e.g. c1
textrequiredcommandPresent when a shell command decides this criterion: it runs in the session's workspace after each iteration, and exit 0 means met. The grader cannot overturn it.
criteria_sourcerequiredWhether the caller supplied the criteria or the platform derived them from the objective — "user" · "derived"
statusrequired"active" · "paused" · "completed" · "stopped"
stop_reasonrequiredWhy a stopped goal stopped; null in every other status — "failed" · "max_iterations" · "spend_budget" · "token_budget" · "time_budget" · "no_progress" · "cleared" · "session_ended" · null
iterationrequiredSelf-started turns taken so far
max_iterationsrequiredmax_spendrequired▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
consumed_spendrequiredWhat this session has spent since the goal started
▸ Show child attributes▾ Hide child attributes
amountcurrency"USD"
max_tokensrequiredToken ceiling for this goal; null = none
consumed_tokensrequiredUncached input plus output tokens over the session's metered model calls since the goal started, grading included. Calls on the session's own model subscription are not metered and not counted.
deadline_atrequiredlast_evaluationrequired▸ Show child attributes▾ Hide child attributes
resultrequired"satisfied" · "needs_revision" · "failed"
explanationrequiredcriteriarequired▸ Show child attributes▾ Hide child attributes
idrequiredmetrequiredreasonrequiredjudged_byWhat decided this criterion on this iteration — "grader" · "command"
iterationrequiredatrequiredcreated_atrequiredupdated_atrequiredcompleted_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/goal/resume \
-H "Authorization: Bearer ast_..."Handoff
Hand this session's context to another agent
Accepted immediately; the move runs in the background. Poll the `status_url` in the response (also sent as the `Location` header) until `status` is terminal, then talk to `target_session`. `last_message_id` bounds how much history is carried; omitted = all of it. An `Idempotency-Key` header dedupes retries.
idrequiredThe source session id (sess_…)
target_agentrequiredmax length 256
last_message_idmax length 256
Accepted — poll status_url
handoffrequired`resolved_mode` is how the move was actually made: `native_fork` when source and target share a harness and the pod's own state could be forked, else `summary` — a written handover the target reads as history, never as instructions. `target_session` is null until the move completes.
▸ Show child attributes▾ Hide child attributes
idrequiredhandoff_…
source_sessiontarget_sessionlast_message_idtarget_agentstatusrequiredLowercased HandoffStatus: pending · checkpointing · provisioning · restoring · completed · retry_wait · failed · cancelled. Terminal: completed, failed, cancelled.
resolved_moderequired"native_fork" · "summary"
resolution_reasoncheckpointWhat was carried across, without its content
summaryWhat was carried across, without its content
errorstatus_urlrequiredGET it to poll the move
created_atrequiredupdated_atrequiredcompleted_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/handoff \
-H "Authorization: Bearer ast_..."The progress of one handoff
idrequiredThe handoff id (handoff_…), as returned by POST /sessions/{id}/handoff
handoffrequired`resolved_mode` is how the move was actually made: `native_fork` when source and target share a harness and the pod's own state could be forked, else `summary` — a written handover the target reads as history, never as instructions. `target_session` is null until the move completes.
▸ Show child attributes▾ Hide child attributes
idrequiredhandoff_…
source_sessiontarget_sessionlast_message_idtarget_agentstatusrequiredLowercased HandoffStatus: pending · checkpointing · provisioning · restoring · completed · retry_wait · failed · cancelled. Terminal: completed, failed, cancelled.
resolved_moderequired"native_fork" · "summary"
resolution_reasoncheckpointWhat was carried across, without its content
summaryWhat was carried across, without its content
errorstatus_urlrequiredGET it to poll the move
created_atrequiredupdated_atrequiredcompleted_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/session-handoffs/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."Tasks
/tasksreadList the workspace's tasks
Most recent activity first. Helper and handoff sessions are counted inside their task and never listed on their own.
attentionReturn only tasks in this state
tasksrequired▸ Show child attributes▾ Hide child attributes
idrequiredsess_… — the root session's id
titlerequiredattentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
open_request_countrequiredOpen requests addressed to the caller
session_countrequiredThe root session plus its helper and handoff sessions
sessionsrequiredEvery session in the task, root first, each with its own share of the state: its own open requests, its own run and its own latest result, measured against the task's seen mark.
▸ Show child attributes▾ Hide child attributes
idrequiredsess_…
rolerequired"primary" · "helper" · "handoff"
attentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
agent_idrequiredThe root session's agent (agent_…)
agent_typerequiredllmrequiredarchivedrequiredlast_activity_atrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/tasks' \
-H "Authorization: Bearer ast_..."/tasks/{id}readOne task with its sessions, open requests and cost
By default the id must name a task root. With by=session, resolves an accessible helper or handoff session to its containing task; both the member and root must be accessible.
idrequiredThe task id: the id of its root session (sess_…)
byResolve this session to its existing task root.
taskrequired▸ Show child attributes▾ Hide child attributes
idrequiredsess_… — the root session's id
titlerequiredattentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
open_request_countrequiredOpen requests addressed to the caller
session_countrequiredThe root session plus its helper and handoff sessions
sessionsrequiredThe root first, then the others in the order they joined
▸ Show child attributes▾ Hide child attributes
idrequiredsess_…
rolerequired"primary" · "helper" · "handoff"
attentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
titlerequiredstatusrequired"provisioning" · "idle" · "running" · "terminated"
agent_idrequiredagent_typerequiredllmrequiredconsumed_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
model_paid_byWho pays for the model in this session: the wallet, or the caller's own account at a vendor. Runtime is charged to the wallet either way. Present where external accounts are turned on.
▸ Show child attributes▾ Hide child attributes
sourcerequired"wallet" · "account"
vendornamecreated_atrequiredagent_idrequiredThe root session's agent (agent_…)
agent_typerequiredllmrequiredarchivedrequiredlast_activity_atrequiredcreated_atrequiredconsumed_costrequiredBilled cost summed over every session in the task, a paid agent's flat fee included
▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
completion_answerrequiredWhat the caller said about whether this task did the job; null until they answer. Other people's answers are not shown.
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnameagent_feesThe flat fees of paid agents in this task. Present only when the task has one.
▸ Show child attributes▾ Hide child attributes
session_idrequiredhandlerequiredfeerequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
statusrequired`held`: set aside from the caller's credit when the task started. `captured`: taken, on the task's first result. `released`: given back because the task was archived or deleted without a result. `disputed`, `refunded`: see the dispute route. — "awaiting_confirmation" · "declined" · "held" · "captured" · "disputed" · "released" · "refunded"
dispute_untilrequiredUntil when the caller may say the task was not completed; null unless the fee is captured and undisputed
disputerequiredWhat the caller said and how it was ruled; null when the fee was never disputed.
requestsrequiredOpen requests addressed to the caller, oldest first. Answer one by sending its reply to `session_id` as a message, exactly as a question is answered in that session.
▸ Show child attributes▾ Hide child attributes
idrequiredThe request id the agent or the platform assigned
session_idrequiredThe session that is waiting (sess_…)
message_idrequiredkindrequired`question`: an agent asked. `approval`: a tool needs the caller's go-ahead before it runs (options `allow`, `deny`), or a workspace rule asks for it before the task itself starts (options `confirm`, `decline`; nothing has run, and declining archives the task). `connect_app`: the agent needs an app that is not connected; it resolves by itself when the caller connects the app, or by answering `skip`. `connect_account`: the task cannot run without the caller's own account at a vendor, or that account has no usage left; what the caller sent is kept and nothing has run. It resolves by itself when the account is connected (`POST /external_accounts`), or by answering `use_wallet` (offered only when the account is exhausted or expired and the task can run on a platform model) or `wait`. `spend`: an agent whose maker asks a flat fee is about to be used for the first time at that price, either as this task's own agent (nothing has run, and nothing runs until it is answered) or as a helper an agent in the task wants to hire. Answer `confirm` or `decline`; a confirmation is remembered for that agent at that price. — "question" · "approval" · "connect_app" · "connect_account" · "spend"
subjectrequiredFor `connect_app`, the app's slug; for `connect_account`, the vendor; for `spend`, the agent's handle
questionrequiredoptionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredlabelrequireddescriptionallow_free_textrequiredrequired_user_idrequiredSet when only one person may answer
due_atrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/tasks/{id}/seenwriteMark the task seen by the caller
Records that the caller has looked at the task now, so a result that already arrived stops reading as `done` for them. Optional session_ids scopes the read to those task members; other members keep their unread results. Other people's view is unchanged. Answers 503 `not_available` until the platform's task tables are in place.
idrequiredThe task id: the id of its root session (sess_…)
session_idsOnly these task members are marked seen; omitted marks all current members. — max length 256
taskrequired▸ Show child attributes▾ Hide child attributes
idrequiredsess_… — the root session's id
titlerequiredattentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
open_request_countrequiredOpen requests addressed to the caller
session_countrequiredThe root session plus its helper and handoff sessions
sessionsrequiredThe root first, then the others in the order they joined
▸ Show child attributes▾ Hide child attributes
idrequiredsess_…
rolerequired"primary" · "helper" · "handoff"
attentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
titlerequiredstatusrequired"provisioning" · "idle" · "running" · "terminated"
agent_idrequiredagent_typerequiredllmrequiredconsumed_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
model_paid_byWho pays for the model in this session: the wallet, or the caller's own account at a vendor. Runtime is charged to the wallet either way. Present where external accounts are turned on.
▸ Show child attributes▾ Hide child attributes
sourcerequired"wallet" · "account"
vendornamecreated_atrequiredagent_idrequiredThe root session's agent (agent_…)
agent_typerequiredllmrequiredarchivedrequiredlast_activity_atrequiredcreated_atrequiredconsumed_costrequiredBilled cost summed over every session in the task, a paid agent's flat fee included
▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
completion_answerrequiredWhat the caller said about whether this task did the job; null until they answer. Other people's answers are not shown.
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnameagent_feesThe flat fees of paid agents in this task. Present only when the task has one.
▸ Show child attributes▾ Hide child attributes
session_idrequiredhandlerequiredfeerequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
statusrequired`held`: set aside from the caller's credit when the task started. `captured`: taken, on the task's first result. `released`: given back because the task was archived or deleted without a result. `disputed`, `refunded`: see the dispute route. — "awaiting_confirmation" · "declined" · "held" · "captured" · "disputed" · "released" · "refunded"
dispute_untilrequiredUntil when the caller may say the task was not completed; null unless the fee is captured and undisputed
disputerequiredWhat the caller said and how it was ruled; null when the fee was never disputed.
requestsrequiredOpen requests addressed to the caller, oldest first. Answer one by sending its reply to `session_id` as a message, exactly as a question is answered in that session.
▸ Show child attributes▾ Hide child attributes
idrequiredThe request id the agent or the platform assigned
session_idrequiredThe session that is waiting (sess_…)
message_idrequiredkindrequired`question`: an agent asked. `approval`: a tool needs the caller's go-ahead before it runs (options `allow`, `deny`), or a workspace rule asks for it before the task itself starts (options `confirm`, `decline`; nothing has run, and declining archives the task). `connect_app`: the agent needs an app that is not connected; it resolves by itself when the caller connects the app, or by answering `skip`. `connect_account`: the task cannot run without the caller's own account at a vendor, or that account has no usage left; what the caller sent is kept and nothing has run. It resolves by itself when the account is connected (`POST /external_accounts`), or by answering `use_wallet` (offered only when the account is exhausted or expired and the task can run on a platform model) or `wait`. `spend`: an agent whose maker asks a flat fee is about to be used for the first time at that price, either as this task's own agent (nothing has run, and nothing runs until it is answered) or as a helper an agent in the task wants to hire. Answer `confirm` or `decline`; a confirmation is remembered for that agent at that price. — "question" · "approval" · "connect_app" · "connect_account" · "spend"
subjectrequiredFor `connect_app`, the app's slug; for `connect_account`, the vendor; for `spend`, the agent's handle
questionrequiredoptionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredlabelrequireddescriptionallow_free_textrequiredrequired_user_idrequiredSet when only one person may answer
due_atrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/seen \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"session_ids":["sess_cmtb7q2j"]}'Say whether the task did the job
The caller's own answer for a task that has a result. Each person has one answer per task; sending it again replaces the earlier one. It counts toward `stats.completed_yes` or `stats.completed_no` of the catalog listing the task's agent stands for. 409 `no_result` while no session of the task has replied. 404 for a task the caller cannot see. Answers 503 `not_migrated` until the platform's answer table is in place.
idrequiredThe task id: the id of its root session (sess_…)
did_the_jobrequiredtaskrequired▸ Show child attributes▾ Hide child attributes
idrequiredsess_… — the root session's id
titlerequiredattentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
open_request_countrequiredOpen requests addressed to the caller
session_countrequiredThe root session plus its helper and handoff sessions
sessionsrequiredThe root first, then the others in the order they joined
▸ Show child attributes▾ Hide child attributes
idrequiredsess_…
rolerequired"primary" · "helper" · "handoff"
attentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
titlerequiredstatusrequired"provisioning" · "idle" · "running" · "terminated"
agent_idrequiredagent_typerequiredllmrequiredconsumed_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
model_paid_byWho pays for the model in this session: the wallet, or the caller's own account at a vendor. Runtime is charged to the wallet either way. Present where external accounts are turned on.
▸ Show child attributes▾ Hide child attributes
sourcerequired"wallet" · "account"
vendornamecreated_atrequiredagent_idrequiredThe root session's agent (agent_…)
agent_typerequiredllmrequiredarchivedrequiredlast_activity_atrequiredcreated_atrequiredconsumed_costrequiredBilled cost summed over every session in the task, a paid agent's flat fee included
▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
completion_answerrequiredWhat the caller said about whether this task did the job; null until they answer. Other people's answers are not shown.
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnameagent_feesThe flat fees of paid agents in this task. Present only when the task has one.
▸ Show child attributes▾ Hide child attributes
session_idrequiredhandlerequiredfeerequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
statusrequired`held`: set aside from the caller's credit when the task started. `captured`: taken, on the task's first result. `released`: given back because the task was archived or deleted without a result. `disputed`, `refunded`: see the dispute route. — "awaiting_confirmation" · "declined" · "held" · "captured" · "disputed" · "released" · "refunded"
dispute_untilrequiredUntil when the caller may say the task was not completed; null unless the fee is captured and undisputed
disputerequiredWhat the caller said and how it was ruled; null when the fee was never disputed.
requestsrequiredOpen requests addressed to the caller, oldest first. Answer one by sending its reply to `session_id` as a message, exactly as a question is answered in that session.
▸ Show child attributes▾ Hide child attributes
idrequiredThe request id the agent or the platform assigned
session_idrequiredThe session that is waiting (sess_…)
message_idrequiredkindrequired`question`: an agent asked. `approval`: a tool needs the caller's go-ahead before it runs (options `allow`, `deny`), or a workspace rule asks for it before the task itself starts (options `confirm`, `decline`; nothing has run, and declining archives the task). `connect_app`: the agent needs an app that is not connected; it resolves by itself when the caller connects the app, or by answering `skip`. `connect_account`: the task cannot run without the caller's own account at a vendor, or that account has no usage left; what the caller sent is kept and nothing has run. It resolves by itself when the account is connected (`POST /external_accounts`), or by answering `use_wallet` (offered only when the account is exhausted or expired and the task can run on a platform model) or `wait`. `spend`: an agent whose maker asks a flat fee is about to be used for the first time at that price, either as this task's own agent (nothing has run, and nothing runs until it is answered) or as a helper an agent in the task wants to hire. Answer `confirm` or `decline`; a confirmation is remembered for that agent at that price. — "question" · "approval" · "connect_app" · "connect_account" · "spend"
subjectrequiredFor `connect_app`, the app's slug; for `connect_account`, the vendor; for `spend`, the agent's handle
questionrequiredoptionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredlabelrequireddescriptionallow_free_textrequiredrequired_user_idrequiredSet when only one person may answer
due_atrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/completion_answer \
-H "Authorization: Bearer ast_..."Answer a request the task is waiting on
Sends the caller's answer to the session that asked, as its next turn, in the same form a click in the app produces. Pass `option_id` for one of the request's options, or `text` where the request accepts free text. A `spend` request is applied before anything is sent: confirming remembers the price and, when the task itself was waiting to start, holds the fee and starts it with what it was given (402 `insufficient_credits` when the caller's credit does not cover the fee; the request stays open). Declining such a start closes the request and the task never runs. A `spend` request that asks to raise a member's monthly limit in a workspace is answered by an owner or admin of that workspace with `option_id` `raise` or `decline` (403 `request_not_yours` for anyone else, the member included): raising sets the limit the request offered and sends on what the member's waiting tasks were given. An optional `note` is sent to the agent after the answer, in the same turn, and is not part of the answer: a surface other than the app uses it to say where the answer came from and how to reply there. 404 when the task has no open request with that id, 403 `request_not_yours` when it is addressed to someone else, 400 when the answer is not one the request accepts, 409 `session_busy` while the turn that asked is still running (retry once the session is idle).
idrequiredThe task id: the id of its root session (sess_…)
request_idrequiredThe request's `id` from the task's `requests`
option 1▸ Show child attributes▾ Hide child attributes
option_idrequirednotemax length 4000
option 2▸ Show child attributes▾ Hide child attributes
textrequiredmax length 20000
notemax length 4000
session_idrequiredThe session that asked
message_idrequiredThe answer's message; read the session's events from it to follow the turn. Null when a `spend` request was declined, or confirmed for a task that was given nothing to start with.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/requests/ask-7f3c2a/answer \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"option_id":"approve"}'Say a paid agent did not complete the task
For the person who hired, within 72 hours of the task's first result. The fee and the seller's earning then wait for a reviewer, who either refunds the fee to the caller's credit or lets the charge stand. Usage is not refunded. 404 when the task has no agent fee of the caller's, 409 `not_disputable` outside the 72 hours or once it has been disputed, 400 when the task holds more than one fee and `session_id` does not name one.
idrequiredThe task id: the id of its root session (sess_…)
reasonrequiredmax length 1000
session_idtaskrequired▸ Show child attributes▾ Hide child attributes
idrequiredsess_… — the root session's id
titlerequiredattentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
open_request_countrequiredOpen requests addressed to the caller
session_countrequiredThe root session plus its helper and handoff sessions
sessionsrequiredThe root first, then the others in the order they joined
▸ Show child attributes▾ Hide child attributes
idrequiredsess_…
rolerequired"primary" · "helper" · "handoff"
attentionrequiredWhat the caller should do about the task. `needs_you`: a request addressed to the caller is open. `working`: a session in the task is running or starting, or the task is waiting on somebody else. `done`: a result arrived since the caller last marked the task seen. `idle`: nothing new. — "needs_you" · "working" · "done" · "idle"
status_linerequiredOne line, at most 140 characters, on where it stands: the oldest question waiting on the caller, else the start of the latest thing an agent said. Null when no agent has said anything.
titlerequiredstatusrequired"provisioning" · "idle" · "running" · "terminated"
agent_idrequiredagent_typerequiredllmrequiredconsumed_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
model_paid_byWho pays for the model in this session: the wallet, or the caller's own account at a vendor. Runtime is charged to the wallet either way. Present where external accounts are turned on.
▸ Show child attributes▾ Hide child attributes
sourcerequired"wallet" · "account"
vendornamecreated_atrequiredagent_idrequiredThe root session's agent (agent_…)
agent_typerequiredllmrequiredarchivedrequiredlast_activity_atrequiredcreated_atrequiredconsumed_costrequiredBilled cost summed over every session in the task, a paid agent's flat fee included
▸ Show child attributes▾ Hide child attributes
amountrequiredInteger US cents, as a string
currencyrequired"USD"
completion_answerrequiredWhat the caller said about whether this task did the job; null until they answer. Other people's answers are not shown.
payerWho pays for it, decided once when it was created and never changed. Present only when a payer was recorded, which happens in a team workspace where workspace wallets are on; absent means its owner's own balance pays.
▸ Show child attributes▾ Hide child attributes
typerequired`workspace`: the team workspace's own wallet. `personal`: the balance of the person who started it. — "workspace" · "personal"
workspaceThe paying workspace; only with type workspace
▸ Show child attributes▾ Hide child attributes
slugnameagent_feesThe flat fees of paid agents in this task. Present only when the task has one.
▸ Show child attributes▾ Hide child attributes
session_idrequiredhandlerequiredfeerequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents
currencyrequired"USD"
statusrequired`held`: set aside from the caller's credit when the task started. `captured`: taken, on the task's first result. `released`: given back because the task was archived or deleted without a result. `disputed`, `refunded`: see the dispute route. — "awaiting_confirmation" · "declined" · "held" · "captured" · "disputed" · "released" · "refunded"
dispute_untilrequiredUntil when the caller may say the task was not completed; null unless the fee is captured and undisputed
disputerequiredWhat the caller said and how it was ruled; null when the fee was never disputed.
requestsrequiredOpen requests addressed to the caller, oldest first. Answer one by sending its reply to `session_id` as a message, exactly as a question is answered in that session.
▸ Show child attributes▾ Hide child attributes
idrequiredThe request id the agent or the platform assigned
session_idrequiredThe session that is waiting (sess_…)
message_idrequiredkindrequired`question`: an agent asked. `approval`: a tool needs the caller's go-ahead before it runs (options `allow`, `deny`), or a workspace rule asks for it before the task itself starts (options `confirm`, `decline`; nothing has run, and declining archives the task). `connect_app`: the agent needs an app that is not connected; it resolves by itself when the caller connects the app, or by answering `skip`. `connect_account`: the task cannot run without the caller's own account at a vendor, or that account has no usage left; what the caller sent is kept and nothing has run. It resolves by itself when the account is connected (`POST /external_accounts`), or by answering `use_wallet` (offered only when the account is exhausted or expired and the task can run on a platform model) or `wait`. `spend`: an agent whose maker asks a flat fee is about to be used for the first time at that price, either as this task's own agent (nothing has run, and nothing runs until it is answered) or as a helper an agent in the task wants to hire. Answer `confirm` or `decline`; a confirmation is remembered for that agent at that price. — "question" · "approval" · "connect_app" · "connect_account" · "spend"
subjectrequiredFor `connect_app`, the app's slug; for `connect_account`, the vendor; for `spend`, the agent's handle
questionrequiredoptionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredlabelrequireddescriptionallow_free_textrequiredrequired_user_idrequiredSet when only one person may answer
due_atrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/agent-fee/dispute \
-H "Authorization: Bearer ast_..."List the files in the task's file space
The folder every session of the task has at `/workspace/task/`: a handoff session and a helper see the same files as the session that wrote them. Current files only, by path. Answers 503 `not_migrated` until the platform's task file tables are in place.
idrequiredThe task id: the id of its root session (sess_…)
filesrequired▸ Show child attributes▾ Hide child attributes
pathrequiredsize_bytesrequiredsha256requiredupdated_atrequiredupdated_by_sessionrequiredThe session that last wrote it; null when a person or developer did
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/files' \
-H "Authorization: Bearer ast_..."Download the task's files as one archive
A zip archive of the current files in the task's file space, each at its own path. 413 `export_too_large` when they are more than 64 MiB together; download them one at a time then.
idrequiredThe task id: the id of its root session (sess_…)
The archive
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/export' \
-H "Authorization: Bearer ast_..."Read one task file, or its history
Returns the file's bytes. With `versions=true` returns instead every recorded write of that path, newest first, including writes to a path that has since been deleted.
idrequiredThe task id: the id of its root session (sess_…)
pathrequiredThe file's path inside the task's file space, such as report.md or data/rows.csv
versionsThe bytes, or the version list
versionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredsha256requiredsize_bytesrequiredsessionrequiredconflictrequiredThe writer had not seen what was current when it wrote
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/files/report.md' \
-H "Authorization: Bearer ast_..."Write one task file
The body is the file's bytes (16 MiB at most; 413 `file_too_large`). The write becomes the current file. `base_sha256` names what the caller last saw at the path (empty for nothing); when something else is current the write is still made, both versions are kept, and the response says `conflict: true`. A task holds at most 2000 files and 256 MiB (413 `task_files_full`). Sessions of the task pick the file up at the start of their next turn.
idrequiredThe task id: the id of its root session (sess_…)
pathrequiredThe file's path inside the task's file space, such as report.md or data/rows.csv
base_sha256filerequired▸ Show child attributes▾ Hide child attributes
pathrequiredsize_bytesrequiredsha256requiredupdated_atrequiredupdated_by_sessionrequiredThe session that last wrote it; null when a person or developer did
conflictrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/files/report.md \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: text/markdown" \
--data-binary @report.mdRemove one task file
Removes the path from the current files. Its history stays readable with `versions=true`.
idrequiredThe task id: the id of its root session (sess_…)
pathrequiredThe file's path inside the task's file space, such as report.md or data/rows.csv
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/files/report.md \
-H "Authorization: Bearer ast_..."/tasks/{id}/callbacktask passReport on a task from the server its agent runs on
Authorized by the pass handed to that server with the turn, sent as `Authorization: Bearer`, and by nothing else: any other credential is refused with 403. `message` shows progress and keeps the turn open. `result` is the answer; `request` asks the person a question, which they answer like any other request on the task; `error` says the work could not be done. Those three end the turn and the pass, so write the task's files first. 409 `turn_ended` once the turn is over; 401 for a pass that has ended.
idrequiredThe task's id.
type: "message"Something to show while the work goes on. The turn stays open.
▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredmax length 200000
type: "result"The answer. Ends the turn and the pass.
▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredmax length 200000
type: "request"A question for the person. Ends the turn and the pass; the answer arrives as the task's next turn, with a new pass.
▸ Show child attributes▾ Hide child attributes
typerequiredquestionrequiredmax length 2000
options▸ Show child attributes▾ Hide child attributes
idrequiredmax length 200
labelrequiredmax length 200
descriptionmax length 500
allow_free_textWhether the person may type an answer. Defaults to true; must be true when there are no options.
type: "error"The work could not be done. Ends the turn and the pass; the person reads the message.
▸ Show child attributes▾ Hide child attributes
typerequiredmessagerequiredmax length 500
Recorded
okrequiredrequest_idThe id of the request that was raised, for `request`.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/tasks/sess_cmtb7q2j/callback \
-H "Authorization: Bearer ast_..."Notifications
Which task events the caller is emailed and pushed about
A person who has never chosen gets the defaults: for email `needs_you` on and `done` off, for push both on. Every task email also carries a link that turns its kind off without signing in.
notification_preferencesrequiredThe caller's own choices. They follow the person across workspaces.
▸ Show child attributes▾ Hide child attributes
pushrequiredWhich kinds reach the browsers the caller subscribed (`/push-subscriptions`). Both on unless turned off; without a subscribed browser nothing is pushed.
▸ Show child attributes▾ Hide child attributes
needs_yourequiredNotify my browsers when one of my tasks starts waiting on me.
donerequiredNotify my browsers when one of my tasks produces a result while I am away.
emailrequired▸ Show child attributes▾ Hide child attributes
needs_yourequiredEmail me when one of my tasks starts waiting on me and I have not looked at it. On unless turned off.
donerequiredEmail me when one of my tasks produces a result while I am away. Off unless turned on.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/notification-preferences' \
-H "Authorization: Bearer ast_..."Change which task events the caller is emailed and pushed about
Send `email`, `push` or both, each with only the kinds to change; the response holds all of them. Answers 503 `not_available` until the platform's notification tables are in place.
email▸ Show child attributes▾ Hide child attributes
needs_youdonepush▸ Show child attributes▾ Hide child attributes
needs_youdonenotification_preferencesrequiredThe caller's own choices. They follow the person across workspaces.
▸ Show child attributes▾ Hide child attributes
pushrequiredWhich kinds reach the browsers the caller subscribed (`/push-subscriptions`). Both on unless turned off; without a subscribed browser nothing is pushed.
▸ Show child attributes▾ Hide child attributes
needs_yourequiredNotify my browsers when one of my tasks starts waiting on me.
donerequiredNotify my browsers when one of my tasks produces a result while I am away.
emailrequired▸ Show child attributes▾ Hide child attributes
needs_yourequiredEmail me when one of my tasks starts waiting on me and I have not looked at it. On unless turned off.
donerequiredEmail me when one of my tasks produces a result while I am away. Off unless turned on.
{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/notification-preferences \
-H "Authorization: Bearer ast_..."The browsers the caller is notified in
A subscribed browser gets a push notification when one of the caller's tasks starts waiting on them or has a result, under the same rules as task emails, for the kinds left on under `push` in `/notification-preferences`. `application_server_key` is the key a browser subscribes with; it is null, and the list empty, where push is not turned on.
application_server_keyrequireddatarequired▸ Show child attributes▾ Hide child attributes
idrequiredkindrequired"web"
endpointrequiredThe push service's address for that browser.
created_atrequiredlast_seen_atrequiredWhen that browser last subscribed.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/push-subscriptions' \
-H "Authorization: Bearer ast_..."/push-subscriptionswriteSubscribe a browser to push notifications
Send what the browser's `pushManager.subscribe()` returned. Subscribing the same browser again keeps one subscription. Answers 403 `not_enabled` where push is not turned on, 400 for an endpoint that is not a browser push service's, and 503 `not_migrated` until the platform's push tables are in place.
endpointrequiredkeysrequired▸ Show child attributes▾ Hide child attributes
p256dhrequiredauthrequiredsubscriptionrequiredOne browser the caller asked to be notified in. Its keys are never returned.
▸ Show child attributes▾ Hide child attributes
idrequiredkindrequired"web"
endpointrequiredThe push service's address for that browser.
created_atrequiredlast_seen_atrequiredWhen that browser last subscribed.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/push-subscriptions \
-H "Authorization: Bearer ast_..."Stop notifying one of the caller's browsers
idrequiredRemoved
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/push-subscriptions/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Agent catalog
/catalog/enginespublicRead operational harness availability
The delisted engine identities, read without an HTTP cache. New acquisition rejects them; existing sessions are retained.
Current delisting state
delistedrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/engines' \
-H "Authorization: Bearer ast_..."/catalog/agentspublicList hireable agents
Every listed agent: platform engines, and other people's agents that were reviewed and approved, each served as it was approved and carrying `seller`. Needs no credentials; a caller that sends them also gets its own workspace's listings. Answers 503 `not_migrated` until the platform's catalog tables are in place.
categoryqMatches handle, name, tagline and description
sortrequiresKeep the agents whose stated requirements match: `account` needs the caller's own account at a vendor, `no_account` needs none, `mcp_servers` can use MCP servers. An account requirement is stated only where external accounts are turned on.
agentsrequired▸ Show child attributes▾ Hide child attributes
handlerequiredGlobally unique and stable: lower-case letters, digits and underscores. What a person types after "/".
kindrequiredA platform engine, or an agent a person listed — "engine" · "agent"
engine_typerequiredThe agent type to create an agent with, for an engine listing
agent_idrequiredThe agent one of the caller's own workspace listings stands for; null for an engine and for another person's agent
visibilityrequiredpublic for everyone: an engine, or another person's agent that was reviewed and approved. workspace for the caller's own listing, whether or not it is also public. — "public" · "workspace"
sellerrequiredWho made a public agent that is not a platform engine, by the name they chose. Null for an engine and for the caller's own listing.
namerequiredtaglinerequiredOne line, at most 140 characters
descriptionrequireddoesrequiredWhat it does. Empty when not yet written; never guessed.
does_notrequiredWhat it does not do. Empty when not yet written.
categoriesrequired"websites" · "content" · "video" · "code" · "research" · "general"
examplesrequiredExample tasks
requirementsrequiredWhat the agent needs, stated rather than hidden. `mcp_servers` says whether it can use MCP servers; `website` is the engine's own site. `hosted_by_seller: { host }` is present when the agent runs on its maker's own server instead of a sandbox: what a person sends it, and the files of the task, go to that host, and a person's first task with it waits for them to agree (a task request).
pricingrequired`{ mode: "usage" }`: the model and tool usage the task incurs, with no agent fee. `{ mode: "per_task", fee: { amount, currency } }`: usage, plus a flat fee the agent's maker asks for each task; `amount` is whole US cents as a string. Starting such an agent asks the person to confirm the price the first time (a task request of kind `spend`), holds the fee on their credit when the task starts and takes it when the task gives its first result.
statsrequiredCounts from real use, recounted hourly; never estimated. `uses`: sessions started on the agent. `comparisons` and `wins`: decided side-by-side comparisons the agent took part in, and the ones a person picked it in. `completed_yes` and `completed_no`: people who said a task on this agent did the job, and people who said it did not (`PUT /tasks/{id}/completion_answer`).
▸ Show child attributes▾ Hide child attributes
usesrequiredcomparisonsrequiredwinsrequiredcompleted_yesrequiredcompleted_norequiredusageWhat one task typically consumes: medians over the agent's sessions of the last 30 days that metered model usage. Null until at least 10 such sessions exist.
conformancerequiredThe verdicts of the listing's latest finished conformance run; for another person's agent, of the run it was submitted with. Null when it has never finished one.
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/agents' \
-H "Authorization: Bearer ast_..."/catalog/agents/{handle}publicOne agent by handle
handlerequiredThe agent's handle; a leading @ is accepted
agentrequired▸ Show child attributes▾ Hide child attributes
handlerequiredGlobally unique and stable: lower-case letters, digits and underscores. What a person types after "/".
kindrequiredA platform engine, or an agent a person listed — "engine" · "agent"
engine_typerequiredThe agent type to create an agent with, for an engine listing
agent_idrequiredThe agent one of the caller's own workspace listings stands for; null for an engine and for another person's agent
visibilityrequiredpublic for everyone: an engine, or another person's agent that was reviewed and approved. workspace for the caller's own listing, whether or not it is also public. — "public" · "workspace"
sellerrequiredWho made a public agent that is not a platform engine, by the name they chose. Null for an engine and for the caller's own listing.
namerequiredtaglinerequiredOne line, at most 140 characters
descriptionrequireddoesrequiredWhat it does. Empty when not yet written; never guessed.
does_notrequiredWhat it does not do. Empty when not yet written.
categoriesrequired"websites" · "content" · "video" · "code" · "research" · "general"
examplesrequiredExample tasks
requirementsrequiredWhat the agent needs, stated rather than hidden. `mcp_servers` says whether it can use MCP servers; `website` is the engine's own site. `hosted_by_seller: { host }` is present when the agent runs on its maker's own server instead of a sandbox: what a person sends it, and the files of the task, go to that host, and a person's first task with it waits for them to agree (a task request).
pricingrequired`{ mode: "usage" }`: the model and tool usage the task incurs, with no agent fee. `{ mode: "per_task", fee: { amount, currency } }`: usage, plus a flat fee the agent's maker asks for each task; `amount` is whole US cents as a string. Starting such an agent asks the person to confirm the price the first time (a task request of kind `spend`), holds the fee on their credit when the task starts and takes it when the task gives its first result.
statsrequiredCounts from real use, recounted hourly; never estimated. `uses`: sessions started on the agent. `comparisons` and `wins`: decided side-by-side comparisons the agent took part in, and the ones a person picked it in. `completed_yes` and `completed_no`: people who said a task on this agent did the job, and people who said it did not (`PUT /tasks/{id}/completion_answer`).
▸ Show child attributes▾ Hide child attributes
usesrequiredcomparisonsrequiredwinsrequiredcompleted_yesrequiredcompleted_norequiredusageWhat one task typically consumes: medians over the agent's sessions of the last 30 days that metered model usage. Null until at least 10 such sessions exist.
conformancerequiredThe verdicts of the listing's latest finished conformance run; for another person's agent, of the run it was submitted with. Null when it has never finished one.
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/agents/handle' \
-H "Authorization: Bearer ast_..."/catalog/listingswriteList one of your own agents under a handle
The listing is visible to your workspace only, and `agent: "@handle"` then starts a session with that agent. A handle is unique across the platform, engines included; a taken one is 409 `handle_taken`. Listing the same agent again replaces its listing and frees the old handle. A listing whose agent is archived or deleted stops being offered.
agent_idrequiredhandlerequired2 to 40 lower-case letters, digits or underscores; a leading @ is accepted
taglinerequiredmax length 140
descriptionmax length 4000
categoriesDefaults to general — "websites" · "content" · "video" · "code" · "research" · "general"
doesmax length 300
does_notmax length 300
examplesmax length 300
agentrequired▸ Show child attributes▾ Hide child attributes
handlerequiredGlobally unique and stable: lower-case letters, digits and underscores. What a person types after "/".
kindrequiredA platform engine, or an agent a person listed — "engine" · "agent"
engine_typerequiredThe agent type to create an agent with, for an engine listing
agent_idrequiredThe agent one of the caller's own workspace listings stands for; null for an engine and for another person's agent
visibilityrequiredpublic for everyone: an engine, or another person's agent that was reviewed and approved. workspace for the caller's own listing, whether or not it is also public. — "public" · "workspace"
sellerrequiredWho made a public agent that is not a platform engine, by the name they chose. Null for an engine and for the caller's own listing.
namerequiredtaglinerequiredOne line, at most 140 characters
descriptionrequireddoesrequiredWhat it does. Empty when not yet written; never guessed.
does_notrequiredWhat it does not do. Empty when not yet written.
categoriesrequired"websites" · "content" · "video" · "code" · "research" · "general"
examplesrequiredExample tasks
requirementsrequiredWhat the agent needs, stated rather than hidden. `mcp_servers` says whether it can use MCP servers; `website` is the engine's own site. `hosted_by_seller: { host }` is present when the agent runs on its maker's own server instead of a sandbox: what a person sends it, and the files of the task, go to that host, and a person's first task with it waits for them to agree (a task request).
pricingrequired`{ mode: "usage" }`: the model and tool usage the task incurs, with no agent fee. `{ mode: "per_task", fee: { amount, currency } }`: usage, plus a flat fee the agent's maker asks for each task; `amount` is whole US cents as a string. Starting such an agent asks the person to confirm the price the first time (a task request of kind `spend`), holds the fee on their credit when the task starts and takes it when the task gives its first result.
statsrequiredCounts from real use, recounted hourly; never estimated. `uses`: sessions started on the agent. `comparisons` and `wins`: decided side-by-side comparisons the agent took part in, and the ones a person picked it in. `completed_yes` and `completed_no`: people who said a task on this agent did the job, and people who said it did not (`PUT /tasks/{id}/completion_answer`).
▸ Show child attributes▾ Hide child attributes
usesrequiredcomparisonsrequiredwinsrequiredcompleted_yesrequiredcompleted_norequiredusageWhat one task typically consumes: medians over the agent's sessions of the last 30 days that metered model usage. Null until at least 10 such sessions exist.
conformancerequiredThe verdicts of the listing's latest finished conformance run; for another person's agent, of the run it was submitted with. Null when it has never finished one.
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/catalog/listings \
-H "Authorization: Bearer ast_..."Take one of your own listings down
The agent itself is untouched. 404 for a handle that is not one of this workspace's listings.
handlerequiredThe agent's handle; a leading @ is accepted
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/catalog/listings/handle \
-H "Authorization: Bearer ast_..."Start a conformance run of one of your own listings
Answers at once with the run as `running`; read it back with GET. The suite uses the listing the way a customer would, through this API and as you: it starts sessions in your workspace, which you pay for, and deletes them when it is done. 404 for a handle that is not one of this workspace's listings, an engine included. 409 `conformance_running` while a run of that listing is still going.
handlerequiredThe agent's handle; a leading @ is accepted
runrequired▸ Show child attributes▾ Hide child attributes
idrequiredhandlerequiredstatusrequiredA run still going after 30 minutes is reported as failed. — "running" · "finished" · "failed"
started_atrequiredfinished_atrequiredreasonrequiredWhy the run could not finish; null unless it failed
required_passedrequiredNo required check failed and at least one ran. False until the run finished.
all_passedrequiredEvery check ran and passed. False until the run finished.
reportrequiredEvery check with its outcome; null until the run finished.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/catalog/listings/handle/conformance \
-H "Authorization: Bearer ast_..."The latest conformance run of one of your own listings
`run` is null when the listing has never been run. 404 for a handle that is not one of this workspace's listings.
handlerequiredThe agent's handle; a leading @ is accepted
runrequired▸ Show child attributes▾ Hide child attributes
idrequiredhandlerequiredstatusrequiredA run still going after 30 minutes is reported as failed. — "running" · "finished" · "failed"
started_atrequiredfinished_atrequiredreasonrequiredWhy the run could not finish; null unless it failed
required_passedrequiredNo required check failed and at least one ran. False until the run finished.
all_passedrequiredEvery check ran and passed. False until the run finished.
reportrequiredEvery check with its outcome; null until the run finished.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/listings/handle/conformance' \
-H "Authorization: Bearer ast_..."Where one of your own listings stands with the public Market
Whether it can be submitted and what is missing, its latest submission, and the approved version being served. 404 for a handle that is not one of this workspace's listings.
handlerequiredThe agent's handle; a leading @ is accepted
openrequiredWhether this workspace may submit listings to the public Market
missingrequiredWhat still has to be true before the listing can be submitted, in words. Empty when it can be.
pricingPresent only where this workspace may set a flat fee on its public listings.
▸ Show child attributes▾ Hide child attributes
seller_share_percentrequiredThe part of each fee the seller keeps
fee_cents_minrequiredfee_cents_maxrequiredsubmissionrequiredThe latest submission; null when the listing has never been submitted.
publishedrequiredThe approved version being served to everyone; null when the listing is not public.
taken_downrequiredSet when a reviewer took the public listing down and it has not been submitted again.
scheduled_checkWhat the scheduled checks of the approved version found. A public listing's approved version is checked when it is approved and then by the weekly conformance sweep, as its seller and on the seller's credit for usage, under a spend cap. Absent when the listing is not public.
▸ Show child attributes▾ Hide child attributes
passingrequiredWhether the required checks passed at the last scheduled run that finished; null before the first. False takes the listing's `conformance.required_passed` away for everyone; the listing stays public.
reasonrequiredThe required checks that failed, or why the latest run was skipped or could not finish
checked_atrequiredrunningrequiredWhether a scheduled run of this version is going now
next_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/listings/handle/submission' \
-H "Authorization: Bearer ast_..."Submit one of your own listings for the public Market
Stores the listing and its agent as they are now and puts them in front of a reviewer. Once approved, everyone sees the listing and can start it with `agent: "@handle"`; their session runs a hidden copy of the approved agent in their own workspace, on their own wallet. Later edits are not served until a new submission is approved. `fee` asks a flat fee for each task on top of usage; like everything else it takes effect, and changes, only when a submission carrying it is approved, and a submission without it makes the listing usage-only again. 403 `submissions_closed` when this workspace may not submit. 403 `pricing_closed` when `fee` is sent and this workspace may not set a price. 422 `not_submittable` when something is missing: the message names every item. 409 `already_in_review` while an earlier submission is waiting.
handlerequiredThe agent's handle; a leading @ is accepted
seller_namerequiredThe name the Market shows as the maker. Not an email address. — max length 60
feeThe flat fee for each task, in whole US cents: 1 to 100000
▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents — pattern ^[1-9][0-9]*$
currencyrequired"USD"
Submitted
openrequiredWhether this workspace may submit listings to the public Market
missingrequiredWhat still has to be true before the listing can be submitted, in words. Empty when it can be.
pricingPresent only where this workspace may set a flat fee on its public listings.
▸ Show child attributes▾ Hide child attributes
seller_share_percentrequiredThe part of each fee the seller keeps
fee_cents_minrequiredfee_cents_maxrequiredsubmissionrequiredThe latest submission; null when the listing has never been submitted.
publishedrequiredThe approved version being served to everyone; null when the listing is not public.
taken_downrequiredSet when a reviewer took the public listing down and it has not been submitted again.
scheduled_checkWhat the scheduled checks of the approved version found. A public listing's approved version is checked when it is approved and then by the weekly conformance sweep, as its seller and on the seller's credit for usage, under a spend cap. Absent when the listing is not public.
▸ Show child attributes▾ Hide child attributes
passingrequiredWhether the required checks passed at the last scheduled run that finished; null before the first. False takes the listing's `conformance.required_passed` away for everyone; the listing stays public.
reasonrequiredThe required checks that failed, or why the latest run was skipped or could not finish
checked_atrequiredrunningrequiredWhether a scheduled run of this version is going now
next_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/catalog/listings/handle/submission \
-H "Authorization: Bearer ast_..."Withdraw a submission that is waiting for review
404 when nothing of this listing is waiting.
handlerequiredThe agent's handle; a leading @ is accepted
openrequiredWhether this workspace may submit listings to the public Market
missingrequiredWhat still has to be true before the listing can be submitted, in words. Empty when it can be.
pricingPresent only where this workspace may set a flat fee on its public listings.
▸ Show child attributes▾ Hide child attributes
seller_share_percentrequiredThe part of each fee the seller keeps
fee_cents_minrequiredfee_cents_maxrequiredsubmissionrequiredThe latest submission; null when the listing has never been submitted.
publishedrequiredThe approved version being served to everyone; null when the listing is not public.
taken_downrequiredSet when a reviewer took the public listing down and it has not been submitted again.
scheduled_checkWhat the scheduled checks of the approved version found. A public listing's approved version is checked when it is approved and then by the weekly conformance sweep, as its seller and on the seller's credit for usage, under a spend cap. Absent when the listing is not public.
▸ Show child attributes▾ Hide child attributes
passingrequiredWhether the required checks passed at the last scheduled run that finished; null before the first. False takes the listing's `conformance.required_passed` away for everyone; the listing stays public.
reasonrequiredThe required checks that failed, or why the latest run was skipped or could not finish
checked_atrequiredrunningrequiredWhether a scheduled run of this version is going now
next_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/catalog/listings/handle/submission \
-H "Authorization: Bearer ast_..."Stop serving one of your own listings to everyone else
The workspace listing and the agent stay. Sessions other people already started keep running. 404 when the listing is not public.
handlerequiredThe agent's handle; a leading @ is accepted
openrequiredWhether this workspace may submit listings to the public Market
missingrequiredWhat still has to be true before the listing can be submitted, in words. Empty when it can be.
pricingPresent only where this workspace may set a flat fee on its public listings.
▸ Show child attributes▾ Hide child attributes
seller_share_percentrequiredThe part of each fee the seller keeps
fee_cents_minrequiredfee_cents_maxrequiredsubmissionrequiredThe latest submission; null when the listing has never been submitted.
publishedrequiredThe approved version being served to everyone; null when the listing is not public.
taken_downrequiredSet when a reviewer took the public listing down and it has not been submitted again.
scheduled_checkWhat the scheduled checks of the approved version found. A public listing's approved version is checked when it is approved and then by the weekly conformance sweep, as its seller and on the seller's credit for usage, under a spend cap. Absent when the listing is not public.
▸ Show child attributes▾ Hide child attributes
passingrequiredWhether the required checks passed at the last scheduled run that finished; null before the first. False takes the listing's `conformance.required_passed` away for everyone; the listing stays public.
reasonrequiredThe required checks that failed, or why the latest run was skipped or could not finish
checked_atrequiredrunningrequiredWhether a scheduled run of this version is going now
next_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/catalog/listings/handle/publication \
-H "Authorization: Bearer ast_..."/seller/earningsreadWhat you have earned from the fees on your public listings
Totals, a line per listing, a line per captured fee (newest first) and the payouts they went into. The seller keeps the share shown on each line; the rest is the platform's. A `referral` line is the caller's share of a fee another seller's agent was paid by a person the caller brought; it counts in `earned`, `paid` and `unpaid`, not in `gross` or `listings`. A fee is payable once the 72 hours its buyer has to dispute it have passed, and payouts are made once a month. Nothing here identifies a buyer. 404 where flat fees are not offered.
totalsrequired▸ Show child attributes▾ Hide child attributes
grossrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
earnedrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
paidrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
unpaidrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
listingsrequired▸ Show child attributes▾ Hide child attributes
handlerequiredtasksrequiredgrossrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
earnedrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
linesrequired▸ Show child attributes▾ Hide child attributes
idrequiredhandlerequiredkindrequired`reversal`: a fee refunded after it had been paid out, taken off the next payout. `referral`: the caller's share of a fee another seller's agent was paid by a person the caller referred (`POST /seller/referrals`); its `fee` is that fee — "earning" · "reversal" · "referral"
sourcerequiredWho brought the buyer; `referral` on a referral line — "shelf" · "seller_referred" · "helper" · "referral"
feerequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
share_percentrequiredearnedrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
statusrequired"waiting" · "disputed" · "refunded" · "payable" · "in_payout" · "paid"
payable_atrequiredcreated_atrequiredpayoutsrequired▸ Show child attributes▾ Hide child attributes
idrequiredperiod_startrequiredperiod_endrequiredamountrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents; negative on a reversal
currencyrequired"USD"
statusrequired"owed" · "paid"
paid_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/seller/earnings' \
-H "Authorization: Bearer ast_..."/seller/accountreadYour seller account status
Returns the Stripe Connect account status for the caller. 404 when the caller has no seller account record or the payout tables are not yet migrated.
account_statusrequired"pending" · "active" · "restricted"
payout_connectedrequiredTrue when the Stripe Connect account is active and transfers can be sent
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/seller/account' \
-H "Authorization: Bearer ast_..."/seller/accountwriteCreate your seller account record
Creates or upserts the caller's seller account record. Idempotent — calling it again when a record already exists is a no-op. 404 when the payout tables are not yet migrated.
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/seller/account \
-H "Authorization: Bearer ast_..."Start or resume Stripe Connect onboarding
Returns a single-use Stripe account-link URL the seller opens to complete payout setup. 404 when the payout tables are not yet migrated. 503 when the payment processor is not configured.
urlrequiredSingle-use Stripe account-link URL; expires quickly
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/seller/account/connect \
-H "Authorization: Bearer ast_..."/seller/referralswriteRecord that a user was referred by you
Records that the target user was brought to the platform by the caller. A user can have at most one referral source; a second call for the same target is a no-op (200, `recorded: false`). 404 when the payout tables are not yet migrated.
referred_user_idrequiredThe id of the user who was referred
recordedrequiredtrue when this call created the referral row; false when it already existed
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/seller/referrals \
-H "Authorization: Bearer ast_..."/seller/noticesreadWhat you were told about the agents you sell
Newest first: a submission approved or sent back, a listing taken down, a lost `Checked` mark, a ruling on a disputed fee, a payout recorded. Each is also mailed once to the seller where task emails are on for the seller's workspace, unless the seller turned these emails off with the link in one of them. `handle` narrows the list to one listing plus the notices that are about none. 404 where neither public submissions nor flat fees are offered.
handledatarequired▸ Show child attributes▾ Hide child attributes
idrequiredkindrequired"approved" · "sent_back" · "taken_down" · "checks_failed" · "dispute_refunded" · "dispute_upheld" · "payout_paid"
handlerequiredtitlerequiredtextrequiredThe notice in words, with the reviewer's reason or the amount
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/seller/notices' \
-H "Authorization: Bearer ast_..."/catalog/comparison_countsfirst-partyReport comparison counts per handle
For the first-party client that records side-by-side comparison verdicts; any other token is refused with 403. The body is a full snapshot taken at `reported_at`: each handle is set to its totals and a handle left out is removed, so sending the same snapshot again changes nothing and an older one never overwrites a newer one. The totals reach `stats.comparisons` and `stats.wins` on the next hourly recount. Answers 503 `not_migrated` until the platform's table is in place.
reported_atrequiredcountsrequired▸ Show child attributes▾ Hide child attributes
handlerequiredcomparisonsrequiredwinsrequiredhandlesrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/catalog/comparison_counts \
-H "Authorization: Bearer ast_..."/catalog/categoriespublicThe category vocabulary
categoriesrequired▸ Show child attributes▾ Hide child attributes
idrequired"websites" · "content" · "video" · "code" · "research" · "general"
labelrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/categories' \
-H "Authorization: Bearer ast_..."/catalog/environmentspublicList environment listings on the shelf
All workspace-visible environment listings. Needs no credentials; a caller that sends them may also see their own workspace's unpublished listings. Answers 404 when the shelf is not enabled. Answers 503 `not_migrated` until the shelf migration is applied.
qMatches handle, name, tagline and description
categorysortenvironmentsrequired▸ Show child attributes▾ Hide child attributes
idrequiredThe listing id (lst_…)
handlerequiredGlobally unique within environment listings; lower-case letters, digits and underscores
namerequiredtaglinerequiredOne line, at most 140 characters
descriptionrequiredcategoriesrequired"development" · "data" · "ml" · "security" · "web" · "general"
packagesrequiredThe listed environment's package configuration, or null when it has none
toolsrequiredThe listed environment's tool policy, or null when it has none
networkingrequiredThe listed environment's networking configuration, or null when it has none
installsrequiredHow many workspaces have installed this listing
sellerrequiredThe workspace that published the listing
▸ Show child attributes▾ Hide child attributes
namerequiredvisibilityrequiredworkspace = visible only to the owning workspace; public = visible to all — "workspace" · "public"
conformancerequiredReserved; always null in this release
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/environments' \
-H "Authorization: Bearer ast_..."One environment listing by handle
Answers 404 when the shelf is not enabled, the handle is not found, or the listing belongs to a different workspace and the shelf is restricted to this workspace only.
handlerequiredThe listing handle
environmentrequired▸ Show child attributes▾ Hide child attributes
idrequiredThe listing id (lst_…)
handlerequiredGlobally unique within environment listings; lower-case letters, digits and underscores
namerequiredtaglinerequiredOne line, at most 140 characters
descriptionrequiredcategoriesrequired"development" · "data" · "ml" · "security" · "web" · "general"
packagesrequiredThe listed environment's package configuration, or null when it has none
toolsrequiredThe listed environment's tool policy, or null when it has none
networkingrequiredThe listed environment's networking configuration, or null when it has none
installsrequiredHow many workspaces have installed this listing
sellerrequiredThe workspace that published the listing
▸ Show child attributes▾ Hide child attributes
namerequiredvisibilityrequiredworkspace = visible only to the owning workspace; public = visible to all — "workspace" · "public"
conformancerequiredReserved; always null in this release
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/environments/handle' \
-H "Authorization: Bearer ast_..."Install an environment listing into your workspace
Creates a copy of the listed environment in the caller's workspace that `extends` the original, so composition (packages, tool policy, networking) is applied at write time. A second install of the same listing by the same workspace is idempotent and returns the existing copy. Answers 404 when the shelf is not enabled or the listing is not found. Answers 503 `not_migrated` until the shelf migration is applied.
handlerequiredThe listing handle
environmentrequired▸ Show child attributes▾ Hide child attributes
idrequiredenv_…
namerequiredconfigrequired`packages` are installed into the image at build time — an environment is built when it is created and rebuilt when its config changes, so a session starting from it pays no install cost. `networking` is the egress policy its sessions run under; `limited` needs `allow_package_managers` when packages are declared, or the install could never succeed.
▸ Show child attributes▾ Hide child attributes
typedefault: "cloud"
packages▸ Show child attributes▾ Hide child attributes
aptdefault: [] — max length 512
pipdefault: [] — max length 512
npmdefault: [] — max length 512
networking▸ Show child attributes▾ Hide child attributes
type: "unrestricted"▸ Show child attributes▾ Hide child attributes
typerequiredtype: "limited"▸ Show child attributes▾ Hide child attributes
typerequiredallowed_hostsdefault: [] — max length 253 — pattern ^(\*\.)?([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?$
allow_mcp_serversdefault: false
allow_package_managersdefault: false
is_defaultrequiredWhether a new session that names no environment uses this one. At most one per workspace; setting it on one clears it on the others.
extendsrequiredThe env_… id of the parent environment this one extends, or null. Immutable after create. Child packages, tools.disabled and networking compose on the parent's at write time.
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/catalog/environments/handle/install \
-H "Authorization: Bearer ast_..."Where one of the workspace's listings runs
The secret is never returned here. Answers 404 until running an agent on your own server is open for the workspace.
handlerequiredThe handle of one of the workspace's own listings.
hostingrequired`platform`: in a sandbox. `seller`: on the maker's own server. — "platform" · "seller"
endpoint_urlThe address tasks are sent to. Present when `hosting` is `seller`.
secretThe secret requests are signed with. Present only in the response that made or replaced it.
created_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/catalog/listings/handle/hosting' \
-H "Authorization: Bearer ast_..."Run a listing on your own server
Each task given to the listing is then sent to this address instead of a sandbox, as one POST per turn: `{id, type: "task.turn", created_at, task: {id, session_id, agent}, message: {id, text}, pass: {token, expires_at}, api_base, callback_url}`. The request is signed like a webhook: `x-asteroids-timestamp`, and `x-asteroids-signature` = `v1=` + HMAC-SHA256 of `<timestamp>.<body>` with the listing's secret; check it before trusting the body. Answer 2xx within 10 seconds, then do the work and report to `callback_url`. The request is made once and is not retried; an address that does not answer 2xx in time ends the turn with an error the person reads. `pass.token` is a Bearer credential for that one turn of that one task. It reads the task (`GET /tasks/{id}`), reports to it (`POST /tasks/{id}/callback`), and reads and writes its files (`/tasks/{id}/files`); every other route refuses it with 403. It stops working when the turn ends, when the person stops the turn or archives the task, or after 15 minutes, whichever is first; a turn still open then is ended with an error. A later message from the person, or their answer to a question, is a new turn with a new pass. The address must be https on the public internet. The first call answers 201 with the signing secret, shown once; a later call changes the address and keeps the secret. A listing that is already public keeps running where its approved version said until a new submission is approved. Answers 404 until running an agent on your own server is open for the workspace. 503 `not_migrated` until its tables are in place.
handlerequiredThe handle of one of the workspace's own listings.
endpoint_urlrequiredThe https address tasks are sent to.
Address changed
hostingrequired`platform`: in a sandbox. `seller`: on the maker's own server. — "platform" · "seller"
endpoint_urlThe address tasks are sent to. Present when `hosting` is `seller`.
secretThe secret requests are signed with. Present only in the response that made or replaced it.
created_atupdated_atNow runs on your server; carries the secret
hostingrequired`platform`: in a sandbox. `seller`: on the maker's own server. — "platform" · "seller"
endpoint_urlThe address tasks are sent to. Present when `hosting` is `seller`.
secretThe secret requests are signed with. Present only in the response that made or replaced it.
created_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/catalog/listings/handle/hosting \
-H "Authorization: Bearer ast_..."Run a listing in a sandbox again
Tasks already started on your server can no longer be sent to it: their next turn ends with an error. Answers 404 until running an agent on your own server is open for the workspace.
handlerequiredThe handle of one of the workspace's own listings.
hostingrequired`platform`: in a sandbox. `seller`: on the maker's own server. — "platform" · "seller"
endpoint_urlThe address tasks are sent to. Present when `hosting` is `seller`.
secretThe secret requests are signed with. Present only in the response that made or replaced it.
created_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/catalog/listings/handle/hosting \
-H "Authorization: Bearer ast_..."Replace the secret a listing's requests are signed with
Answers the new secret, shown once. The next request is signed with it; the old one is no longer used. Answers 404 until running an agent on your own server is open for the workspace.
handlerequiredThe handle of one of the workspace's own listings.
Replaced; carries the new secret
hostingrequired`platform`: in a sandbox. `seller`: on the maker's own server. — "platform" · "seller"
endpoint_urlThe address tasks are sent to. Present when `hosting` is `seller`.
secretThe secret requests are signed with. Present only in the response that made or replaced it.
created_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/catalog/listings/handle/hosting/secret \
-H "Authorization: Bearer ast_..."Artifacts
/artifactsreadList the workspace's artifacts
Newest first. With `task_id`, that task's only. Answers 503 `not_migrated` until the platform's artifact tables are in place.
task_idartifactsrequired▸ Show child attributes▾ Hide child attributes
idrequiredtask_idrequiredThe task it belongs to (sess_…)
namerequiredUnique within the task; publishing under the same name adds a version
versionrequiredThe current revision
entryrequiredThe file opened first
filesrequired▸ Show child attributes▾ Hide child attributes
pathrequiredsha256requiredsize_bytesrequiredshare_urlrequiredThe public link, or null while not shared
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/artifacts' \
-H "Authorization: Bearer ast_..."/artifactswritePublish task files as an artifact revision
Publishes paths from the task's file space (`/tasks/{id}/files`) as a new revision of the artifact with that name in the task, creating the artifact on first use. A path that names a folder publishes everything under it. The revision records each file's content at this moment; later edits to the task's files do not change it. `entry` defaults to the only file, or to an `index.html`. 400 when a path names nothing; at most 500 files.
task_idrequirednamerequiredmax length 120
pathsrequiredentryartifactrequired▸ Show child attributes▾ Hide child attributes
idrequiredtask_idrequiredThe task it belongs to (sess_…)
namerequiredUnique within the task; publishing under the same name adds a version
versionrequiredThe current revision
entryrequiredThe file opened first
filesrequired▸ Show child attributes▾ Hide child attributes
pathrequiredsha256requiredsize_bytesrequiredshare_urlrequiredThe public link, or null while not shared
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/artifacts \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"task_id":"sess_cmtb7q2j","name":"Launch page","paths":["site/index.html","site/style.css"],"entry":"site/index.html"}'/artifacts/{id}readOne artifact with every revision
idrequiredThe artifact id
artifactrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/artifacts/cmtb6a1r9t4f2c01s6x8y3z5' \
-H "Authorization: Bearer ast_..."/artifacts/{id}writeRemove an artifact
It stops being listed and its public link stops working. Publishing under the same name in the task afterwards brings it back with the next version number.
idrequiredThe artifact id
okrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/artifacts/cmtb6a1r9t4f2c01s6x8y3z5 \
-H "Authorization: Bearer ast_..."Download an artifact as one archive
A zip archive of every file of the current revision, or of `version=N`, each at its published path. 413 `export_too_large` when the files are more than 64 MiB together.
idrequiredThe artifact id
versionThe archive
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/artifacts/cmtb6a1r9t4f2c01s6x8y3z5/export' \
-H "Authorization: Bearer ast_..."Download one file of an artifact
The current revision's file, or `version=N`. Always sent as a download.
idrequiredThe artifact id
pathrequiredversionThe bytes
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/artifacts/cmtb6a1r9t4f2c01s6x8y3z5/files/report.md' \
-H "Authorization: Bearer ast_..."Browser
Read the session browser and live snapshots
Uses the session's existing universe and token restrictions. Viewing reconnects without restarting execution. Expired browsers are finalized; final screenshots and action history remain readable.
idrequiredThe session id
Authorized browser state, or null when the session has no browser. Provider credentials, interactive viewer links and browser connection URLs are never returned.
browserrequired▸ Show child attributes▾ Hide child attributes
idrequiredstatusrequired"preparing" · "running" · "completed" · "blocked" · "failed" · "stopped"
viewerUrlrequiredAlways null. Observation uses screenshots; interactive provider viewer links are never exposed.
urlrequiredstartedAtrequiredexpiresAtrequiredendedAtrequiredelapsedMsrequiredactionCountrequiredprogressclaimThe agent's completion claim, separate from task verification.
resolvedModelResolved Jev model reported by OpenRouter.
erroractionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredverbrequireddetailrequiredtimestamprequiredstatusrequiredverificationrequired▸ Show child attributes▾ Hide child attributes
statusrequired"passed" · "failed" · "unverified"
checksrequired▸ Show child attributes▾ Hide child attributes
labelrequiredstatusrequired"passed" · "failed" · "unverified"
detailrequiredlastScreenshotrequiredLatest observed or final JPEG as a data URL when capture succeeded.
lastScreenshotAtTime the latest screenshot was captured successfully.
cleanupPendingrequiredA terminal browser may still be releasing provider resources; cleanup is retried durably.
costsrequiredRecorded billed USD, including the fixed Mercury text-entry helper. Receipts can arrive after completion.
▸ Show child attributes▾ Hide child attributes
decisionUsdrequiredhelperUsdrequiredbrowserUsdrequiredruntimeUsdrequiredtotalUsdrequiredMetered cost including waived usage.
chargedUsdrequiredActual amount charged after billing waivers.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/browser' \
-H "Authorization: Bearer ast_..."Prepare an isolated browser for a session
Prepare before sending the task's first turn. Requires an active session, positive credit balance and remaining session budget. An identical repeated request reuses the browser; a different configuration or an ended browser returns 409. The browser has a 15-minute lifetime, fixed viewport and bounded actions. Structured Google Flights verification checks visible route, dates, passengers, cabin and results; tasks without verification remain unverified. Browser usage is billed separately from model and runtime usage.
idrequiredThe session id
taskrequiredmax length 16000
startUrlrequiredviewportrequired▸ Show child attributes▾ Hide child attributes
widthrequiredheightrequiredverification▸ Show child attributes▾ Hide child attributes
kindrequiredoriginrequiredmax length 120
destinationrequiredmax length 120
departureDaterequiredpattern ^\d{4}-\d{2}-\d{2}$
returnDatepattern ^\d{4}-\d{2}-\d{2}$
passengersrequiredcabinrequired"economy" · "premium-economy" · "business" · "first"
Authorized browser state, or null when the session has no browser. Provider credentials, interactive viewer links and browser connection URLs are never returned.
browserrequired▸ Show child attributes▾ Hide child attributes
idrequiredstatusrequired"preparing" · "running" · "completed" · "blocked" · "failed" · "stopped"
viewerUrlrequiredAlways null. Observation uses screenshots; interactive provider viewer links are never exposed.
urlrequiredstartedAtrequiredexpiresAtrequiredendedAtrequiredelapsedMsrequiredactionCountrequiredprogressclaimThe agent's completion claim, separate from task verification.
resolvedModelResolved Jev model reported by OpenRouter.
erroractionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredverbrequireddetailrequiredtimestamprequiredstatusrequiredverificationrequired▸ Show child attributes▾ Hide child attributes
statusrequired"passed" · "failed" · "unverified"
checksrequired▸ Show child attributes▾ Hide child attributes
labelrequiredstatusrequired"passed" · "failed" · "unverified"
detailrequiredlastScreenshotrequiredLatest observed or final JPEG as a data URL when capture succeeded.
lastScreenshotAtTime the latest screenshot was captured successfully.
cleanupPendingrequiredA terminal browser may still be releasing provider resources; cleanup is retried durably.
costsrequiredRecorded billed USD, including the fixed Mercury text-entry helper. Receipts can arrive after completion.
▸ Show child attributes▾ Hide child attributes
decisionUsdrequiredhelperUsdrequiredbrowserUsdrequiredruntimeUsdrequiredtotalUsdrequiredMetered cost including waived usage.
chargedUsdrequiredActual amount charged after billing waivers.
Error — { error: { code, message } }
Error — { error: { code, message } }
Error — { error: { code, message } }
Error — { error: { code, message } }
Error — { error: { code, message } }
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/browser \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"task":"Find the Example Domain heading and stop when it is visible.","startUrl":"https://example.com","viewport":{"width":1120,"height":780}}'Stop the session browser and release its resources
Fences new browser actions before capturing the final page and releasing the browser. Repeated requests retry unfinished cleanup; a session without a browser returns null. This operation stops browser access; use POST /sessions/{id}/interrupt to also interrupt the agent's turn.
idrequiredThe session id
Authorized browser state, or null when the session has no browser. Provider credentials, interactive viewer links and browser connection URLs are never returned.
browserrequired▸ Show child attributes▾ Hide child attributes
idrequiredstatusrequired"preparing" · "running" · "completed" · "blocked" · "failed" · "stopped"
viewerUrlrequiredAlways null. Observation uses screenshots; interactive provider viewer links are never exposed.
urlrequiredstartedAtrequiredexpiresAtrequiredendedAtrequiredelapsedMsrequiredactionCountrequiredprogressclaimThe agent's completion claim, separate from task verification.
resolvedModelResolved Jev model reported by OpenRouter.
erroractionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredverbrequireddetailrequiredtimestamprequiredstatusrequiredverificationrequired▸ Show child attributes▾ Hide child attributes
statusrequired"passed" · "failed" · "unverified"
checksrequired▸ Show child attributes▾ Hide child attributes
labelrequiredstatusrequired"passed" · "failed" · "unverified"
detailrequiredlastScreenshotrequiredLatest observed or final JPEG as a data URL when capture succeeded.
lastScreenshotAtTime the latest screenshot was captured successfully.
cleanupPendingrequiredA terminal browser may still be releasing provider resources; cleanup is retried durably.
costsrequiredRecorded billed USD, including the fixed Mercury text-entry helper. Receipts can arrive after completion.
▸ Show child attributes▾ Hide child attributes
decisionUsdrequiredhelperUsdrequiredbrowserUsdrequiredruntimeUsdrequiredtotalUsdrequiredMetered cost including waived usage.
chargedUsdrequiredActual amount charged after billing waivers.
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/browser \
-H "Authorization: Bearer ast_..."Workspace
List a directory in the session's workspace
Returns up to 200 entries (name, type, size, mtime) for a directory under /data/workspace. Dotfiles are excluded by default; pass ?hidden=true to include them. Only regular files and directories are listed: symlinks, FIFOs, sockets and devices never are. Paths are confined to the workspace root; '..' and absolute paths outside the root return 400 invalid_path. A parked or suspended pod returns 409 session_parked — send a message to wake it.
idrequiredThe session id
pathRelative or absolute path under workspace root; defaults to root
hiddenInclude dotfiles (default false)
pathentries▸ Show child attributes▾ Hide child attributes
nametype"file" · "directory"
sizemtimetruncatedlimit{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/workspace/files' \
-H "Authorization: Bearer ast_..."Download a file from the session's workspace
Returns the raw file bytes as an attachment. Limited to 1 MB. Binary files are supported. Content-Type is inferred from the file extension. Returns 400 not_a_file for directories, 413 file_too_large when over the cap, 403 path_escape for symlink escapes, 409 session_parked when the pod is not running.
idrequiredThe session id
pathrequiredRelative or absolute path to the file under workspace root
File contents
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/workspace/files/content?path=report.md' \
-H "Authorization: Bearer ast_..."Git status and diff summary for each repo in the session's workspace
Finds up to 10 git repositories within three levels of the workspace root and, for each, runs `git status --porcelain=v1` and `git diff --stat HEAD` inside the pod as the workspace owner, with fsmonitor, hooks, external diff drivers and textconv disabled. Each output is bounded to 200 lines. `repos` is empty when the workspace has no repository. Never wakes the pod: 409 session_parked when it is not running, 409 workspace_unsupported when its runtime has no exec or resumes a parked sandbox on contact (E2B), 503 workspace_unavailable when the read cannot run as the workspace owner.
idrequiredThe session id
rootrepos▸ Show child attributes▾ Hide child attributes
pathrepo directory relative to root; "." for the root itself
statusgit status --porcelain=v1 output; null when clean
statgit diff --stat HEAD output; null when no diff or no commit yet
limitmost repos reported
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/workspace/changes' \
-H "Authorization: Bearer ast_..."Copy a folder from the caller's machine into the workspace
The body is the folder as a gzipped tar (up to 25 MB). It is unpacked at <workspace root>/<name> as the workspace owner and made a git repository whose first commit is that copy, so /workspace/patch later answers the work done on it. Wakes a parked pod. 400 invalid_name, 409 already_exists, 413 archive_too_large, 422 invalid_archive.
idrequiredThe session id
namerequiredthe folder's name in the workspace: 1–80 letters, digits, spaces, dots, dashes or underscores
pathfiles{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/workspace/import \
-H "Authorization: Bearer ast_..."The work in one workspace repo since its base branch, as a git patch
Runs inside the pod as the workspace owner and returns one binary-safe `git diff --binary` from the merge base of HEAD with the branch's upstream (or the remote's default branch, or else the base an imported folder recorded, with base_branch "") to the working tree: commits, uncommitted edits and new files that are not ignored. The repository's own index is left as it was. Wakes a parked pod. 400 not_a_repository, 409 no_base when there is no remote branch to compare against, 413 patch_too_large over 5 MB.
idrequiredThe session id
reporequiredrepo directory relative to the workspace root, as /workspace/changes lists it; "." for the root
repobase_branchthe branch the work started from, as the remote names it
base_committhe commit the patch applies to
commitssubjects of the commits since the base, oldest first
patchbase64 of the patch; empty when nothing changed
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/sessions/sess_cmtb7q2j/workspace/patch \
-H "Authorization: Bearer ast_..."This Mac
The person's Macs connected through the Mac app
machinesrequired▸ Show child attributes▾ Hide child attributes
idrequiredmac_…
namerequiredonlinerequiredThe Mac app polled within the last minute
last_seen_atrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/desktop/machines' \
-H "Authorization: Bearer ast_..."/desktop/machineswriteRegister this Mac
The Mac app registers the Mac it runs on and is handed its connect token once. The token is what the app polls the relay with; the person's own token never reaches the app. Edge-routed to the chat-proxy like the ports routes.
namerequiredWhat the person calls this Mac
Registered
machinerequired▸ Show child attributes▾ Hide child attributes
idrequiredmac_…
namerequiredonlinerequiredThe Mac app polled within the last minute
last_seen_atrequiredcreated_atrequiredconnect_tokenrequireddmc_… — shown once; the Mac app's only credential, stored hashed
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/desktop/machines \
-H "Authorization: Bearer ast_..."Revoke a Mac
The app's connect token stops working and every folder it handed over answers 404 from then on.
idrequiredRevoked
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/desktop/machines/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."/desktop/machines/{id}/mountsmachine connect tokenHand a locally selected folder on that Mac to agents
Answers the address a spec's `mcp_servers` entry carries (`{type: "url", name: "this-mac", url: mcp_url}`): a pod's MCP calls on it are relayed to the Mac app, which answers them with file tools rooted at the folder and holds every change for the person's confirmation. This route accepts only that Mac's connect token after its native picker returns a normalized absolute path; an account token cannot create a mount. A Mac that is not polling answers 503 machine_offline to the pod.
idrequiredrootrequiredThe folder's absolute path on that Mac
labelrequiredWhat the thread shows for it
Mounted
idrequireddmt_…
machine_idrequiredrootrequiredlabelrequiredmcp_urlrequiredhttps://mac-<token>.agentsky.dev/mcp — put it in a spec's mcp_servers as a url server; the token is the credential
created_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/desktop/machines/sess_cmtb7q2j/mounts \
-H "Authorization: Bearer ast_..."/desktop/mounts/{id}writeTake a folder back
Its address answers 404 from then on; a running session keeps its spec entry but every call to it fails.
idrequiredRevoked
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/desktop/mounts/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Verify a live folder mount before starting agents
Confirms that the mount id and capability URL still name the same live folder owned by this account in the token's universe, or the account's personal universe when the token is unscoped. A stale, revoked, foreign-universe or mismatched mount answers 404.
idrequiredmcp_urlrequiredThe mount capability URL returned when the folder was selected
The mount is live and owned by this account
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/desktop/mounts/sess_cmtb7q2j/verify \
-H "Authorization: Bearer ast_..."Routines
/routinesreadList routines
cursorlimit1–500, default 50
itemsrequired▸ Show child attributes▾ Hide child attributes
idrtn_… identifier
namedescriptionmetadatatarget{type:"new_session", agent, environment_id?, vault_ids?} — a fresh session per fire (CMA parity) · {type:"session", session_id} — a turn into the existing session every fire (busy target skips with session_busy_error)
initial_eventsschedule5-field POSIX cron + IANA timezone, wall-clock matching, minute granularity; null = manual-run only
budgetPer-run cap (RFC-0080 shape): copied onto each new session (mode new_session) or granted as a per-fire delta allowance consumed+budget (mode session). Clearable.
status"active" · "paused"
paused_reason{type:"manual"} | {type:"error", error:{type}} — non-null exactly when paused
archived_atcreated_atupdated_atcursorhasMore{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routines' \
-H "Authorization: Bearer ast_..."/routineswriteCreate a routine — scheduled agent execution
initial_events (1–50 user.message events) are delivered on every fire. target picks the mode: new_session creates a fresh session per run; session sends the turn into an existing session (busy target → failed run session_busy_error). schedule is a 5-field POSIX cron with an IANA timezone; omit it for a manual-run-only routine. budget bounds each run separately.
namerequiredmax length 256
descriptionmax length 2048
metadatamax length 512
targetrequired▸ Show child attributes▾ Hide child attributes
type: "new_session"▸ Show child attributes▾ Hide child attributes
typerequiredagentrequiredenvironment_idvault_idstype: "session"▸ Show child attributes▾ Hide child attributes
typerequiredsession_idrequiredinitial_eventsrequired▸ Show child attributes▾ Hide child attributes
typerequiredcontentrequired▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "image"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtype: "document"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "text"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typedefault: "text/plain"
datarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtitlecontextinteraction_mode"plan" · "build"
schedule▸ Show child attributes▾ Hide child attributes
typerequiredexpressionrequiredmax length 256
timezonerequiredbudget▸ Show child attributes▾ Hide child attributes
typerequiredmax_list_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents as an integer decimal string, e.g. "125" for $1.25 — max length 15
currencyrequiredroutinerequiredScheduled agent execution: initial_events + a target (new_session per fire, or an existing session) bound to a cron schedule. Fires record routine runs.
▸ Show child attributes▾ Hide child attributes
idrtn_… identifier
namedescriptionmetadatatarget{type:"new_session", agent, environment_id?, vault_ids?} — a fresh session per fire (CMA parity) · {type:"session", session_id} — a turn into the existing session every fire (busy target skips with session_busy_error)
initial_eventsschedule5-field POSIX cron + IANA timezone, wall-clock matching, minute granularity; null = manual-run only
budgetPer-run cap (RFC-0080 shape): copied onto each new session (mode new_session) or granted as a per-fire delta allowance consumed+budget (mode session). Clearable.
status"active" · "paused"
paused_reason{type:"manual"} | {type:"error", error:{type}} — non-null exactly when paused
archived_atcreated_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/routines \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"name":"Weekly compliance scan","target":{"type":"new_session","agent":"agent_cmtb2f0a8m9k7x51q4ez6r0d"},"initial_events":[{"type":"user.message","content":[{"type":"text","text":"Run the weekly compliance scan."}]}],"schedule":{"type":"cron","expression":"0 20 * * 5","timezone":"America/New_York"}}'/routines/{id}readRoutine detail
idrequiredThe routine id (rtn_…)
routinerequiredScheduled agent execution: initial_events + a target (new_session per fire, or an existing session) bound to a cron schedule. Fires record routine runs.
▸ Show child attributes▾ Hide child attributes
idrtn_… identifier
namedescriptionmetadatatarget{type:"new_session", agent, environment_id?, vault_ids?} — a fresh session per fire (CMA parity) · {type:"session", session_id} — a turn into the existing session every fire (busy target skips with session_busy_error)
initial_eventsschedule5-field POSIX cron + IANA timezone, wall-clock matching, minute granularity; null = manual-run only
budgetPer-run cap (RFC-0080 shape): copied onto each new session (mode new_session) or granted as a per-fire delta allowance consumed+budget (mode session). Clearable.
status"active" · "paused"
paused_reason{type:"manual"} | {type:"error", error:{type}} — non-null exactly when paused
archived_atcreated_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routines/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/routines/{id}writeUpdate a routine — omit preserves; null clears schedule/budget
initial_events is a full replacement; metadata is key-patched (null deletes a key); name and target cannot be cleared. Archived routines are immutable (409).
idrequiredThe routine id (rtn_…)
namemax length 256
descriptionmax length 2048
metadatatarget▸ Show child attributes▾ Hide child attributes
type: "new_session"▸ Show child attributes▾ Hide child attributes
typerequiredagentrequiredenvironment_idvault_idstype: "session"▸ Show child attributes▾ Hide child attributes
typerequiredsession_idrequiredinitial_events▸ Show child attributes▾ Hide child attributes
typerequiredcontentrequired▸ Show child attributes▾ Hide child attributes
type: "text"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "image"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtype: "document"▸ Show child attributes▾ Hide child attributes
typerequiredsourcerequired▸ Show child attributes▾ Hide child attributes
type: "base64"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typerequireddatarequiredtype: "text"▸ Show child attributes▾ Hide child attributes
typerequiredmedia_typedefault: "text/plain"
datarequiredtype: "url"▸ Show child attributes▾ Hide child attributes
typerequiredurlrequiredtype: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredtitlecontextinteraction_mode"plan" · "build"
schedule▸ Show child attributes▾ Hide child attributes
typerequiredexpressionrequiredmax length 256
timezonerequiredbudget▸ Show child attributes▾ Hide child attributes
typerequiredmax_list_costrequired▸ Show child attributes▾ Hide child attributes
amountrequiredWhole US cents as an integer decimal string, e.g. "125" for $1.25 — max length 15
currencyrequiredroutinerequiredScheduled agent execution: initial_events + a target (new_session per fire, or an existing session) bound to a cron schedule. Fires record routine runs.
▸ Show child attributes▾ Hide child attributes
idrtn_… identifier
namedescriptionmetadatatarget{type:"new_session", agent, environment_id?, vault_ids?} — a fresh session per fire (CMA parity) · {type:"session", session_id} — a turn into the existing session every fire (busy target skips with session_busy_error)
initial_eventsschedule5-field POSIX cron + IANA timezone, wall-clock matching, minute granularity; null = manual-run only
budgetPer-run cap (RFC-0080 shape): copied onto each new session (mode new_session) or granted as a per-fire delta allowance consumed+budget (mode session). Clearable.
status"active" · "paused"
paused_reason{type:"manual"} | {type:"error", error:{type}} — non-null exactly when paused
archived_atcreated_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/routines/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"schedule":{"type":"cron","expression":"0 9 * * 1-5","timezone":"UTC"}}'/routines/{id}/pausewritePause — suppress scheduled fires; manual runs still work
idrequiredThe routine id (rtn_…)
routinerequiredScheduled agent execution: initial_events + a target (new_session per fire, or an existing session) bound to a cron schedule. Fires record routine runs.
▸ Show child attributes▾ Hide child attributes
idrtn_… identifier
namedescriptionmetadatatarget{type:"new_session", agent, environment_id?, vault_ids?} — a fresh session per fire (CMA parity) · {type:"session", session_id} — a turn into the existing session every fire (busy target skips with session_busy_error)
initial_eventsschedule5-field POSIX cron + IANA timezone, wall-clock matching, minute granularity; null = manual-run only
budgetPer-run cap (RFC-0080 shape): copied onto each new session (mode new_session) or granted as a per-fire delta allowance consumed+budget (mode session). Clearable.
status"active" · "paused"
paused_reason{type:"manual"} | {type:"error", error:{type}} — non-null exactly when paused
archived_atcreated_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/pause \
-H "Authorization: Bearer ast_..."Unpause — resumes from the NEXT occurrence; missed fires are never backfilled
idrequiredThe routine id (rtn_…)
routinerequiredScheduled agent execution: initial_events + a target (new_session per fire, or an existing session) bound to a cron schedule. Fires record routine runs.
▸ Show child attributes▾ Hide child attributes
idrtn_… identifier
namedescriptionmetadatatarget{type:"new_session", agent, environment_id?, vault_ids?} — a fresh session per fire (CMA parity) · {type:"session", session_id} — a turn into the existing session every fire (busy target skips with session_busy_error)
initial_eventsschedule5-field POSIX cron + IANA timezone, wall-clock matching, minute granularity; null = manual-run only
budgetPer-run cap (RFC-0080 shape): copied onto each new session (mode new_session) or granted as a per-fire delta allowance consumed+budget (mode session). Clearable.
status"active" · "paused"
paused_reason{type:"manual"} | {type:"error", error:{type}} — non-null exactly when paused
archived_atcreated_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/unpause \
-H "Authorization: Bearer ast_..."Archive — terminal; the schedule stops and the routine becomes immutable
idrequiredThe routine id (rtn_…)
routinerequiredScheduled agent execution: initial_events + a target (new_session per fire, or an existing session) bound to a cron schedule. Fires record routine runs.
▸ Show child attributes▾ Hide child attributes
idrtn_… identifier
namedescriptionmetadatatarget{type:"new_session", agent, environment_id?, vault_ids?} — a fresh session per fire (CMA parity) · {type:"session", session_id} — a turn into the existing session every fire (busy target skips with session_busy_error)
initial_eventsschedule5-field POSIX cron + IANA timezone, wall-clock matching, minute granularity; null = manual-run only
budgetPer-run cap (RFC-0080 shape): copied onto each new session (mode new_session) or granted as a per-fire delta allowance consumed+budget (mode session). Clearable.
status"active" · "paused"
paused_reason{type:"manual"} | {type:"error", error:{type}} — non-null exactly when paused
archived_atcreated_atupdated_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/archive \
-H "Authorization: Bearer ast_..."/routines/{id}/runwriteRun now, outside the schedule; works while paused
With no body it is a manual run: trigger_context {type:"manual"}. With `input` or `idempotency_key` it is an API-triggered run: trigger_context {type:"api"}; the input is added to the run's first message under the label "Input for this run:", and a repeated idempotency_key on the same routine returns the first run instead of starting another. Neither emits routine_run webhooks.
idrequiredThe routine id (rtn_…)
inputWhat this run should work on, such as an event's payload — max length 50000
idempotency_keyThe caller's id for the event; a repeat returns the first run — max length 200
runrequiredOne fire attempt. Exactly one of session_id / error is non-null.
▸ Show child attributes▾ Hide child attributes
idrrun_… identifier
routine_idtrigger_context{type:"schedule", scheduled_at} | {type:"manual"}
session_iderror{type, message}. Types: agent_archived_error · agent_not_found_error · session_archived_error · session_not_found_error · session_busy_error · environment_archived_error · environment_not_found_error · vault_not_found_error · insufficient_credits_error · rate_limited_error · run_rejected_error · unknown_error. Unrecoverable types auto-pause the routine; transient ones (credits, rate limit, busy) leave it active for the next occurrence. precheck_unchanged is not a failure: the scheduled fire was skipped because the routine's precheck URL returned the same content as at the last run; no session started, the routine stays active and no routine_run webhook is sent.
agentResolved agent reference at fire time
created_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/run \
-H "Authorization: Bearer ast_..."Whether the routine has an inbound URL
`inbound_url` is null when there is none. The URL itself is never returned here, only the start of its secret.
idrequiredThe routine id (rtn_…)
inbound_urlrequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredprefixrequiredThe start of the secret in the URL
created_atrequiredlast_used_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/inbound-url' \
-H "Authorization: Bearer ast_..."Make the routine's inbound URL
Returns a URL that starts a run of this routine when posted to, with no API token: for a service that can only call a URL. It replaces any earlier one, which stops working at once. The URL carries its own secret and is returned only in this response.
idrequiredThe routine id (rtn_…)
inbound_urlrequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredprefixrequiredThe start of the secret in the URL
created_atrequiredlast_used_atrequiredurlrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/inbound-url \
-H "Authorization: Bearer ast_..."Remove the routine's inbound URL
idrequiredThe routine id (rtn_…)
removedrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/inbound-url \
-H "Authorization: Bearer ast_..."Whether the routine emails its result
idrequiredThe routine id (rtn_…)
result_emailrequired▸ Show child attributes▾ Hide child attributes
enabledrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/result-email' \
-H "Authorization: Bearer ast_..."Email the routine's creator the result of each run
When a run finishes, its creator gets one email with the last thing the agent said and a link to the run. It is sent whatever the person chose for finished-task emails, and every email carries a link that turns this routine's emails off. Only a routine whose target is `new_session` can have it (400 otherwise); an archived routine answers 409.
idrequiredThe routine id (rtn_…)
result_emailrequired▸ Show child attributes▾ Hide child attributes
enabledrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/result-email \
-H "Authorization: Bearer ast_..."Stop emailing the routine's result
idrequiredThe routine id (rtn_…)
result_emailrequired▸ Show child attributes▾ Hide child attributes
enabledrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/result-email \
-H "Authorization: Bearer ast_..."The routine's precheck
`precheck` is null when there is none. It carries what the last check before a scheduled fire found.
idrequiredThe routine id (rtn_…)
precheckrequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredurlrequiredcreated_atrequiredlast_checked_atrequiredWhen the URL was last checked before a scheduled fire
last_resultrequiredchanged: the fire ran. unchanged: the fire was skipped. failed: the check could not be completed and the fire ran anyway. — "changed" · "unchanged" · "failed" · null
last_errorrequired{type, message} when last_result is failed. Types: address_not_allowed · dns_failed · redirect · http_status · too_large · timeout · network.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/precheck' \
-H "Authorization: Bearer ast_..."Run scheduled fires only when a URL's content changed
Before each scheduled fire the platform GETs `url` and compares its content with the content at the last scheduled fire that ran. The same content skips the fire: it is recorded as a run with error.type `precheck_unchanged` and no session, and nothing is charged. New content, and the first check, run the fire. A check that cannot be completed (a redirect, a status outside 2xx, more than 256 KiB, more than 5 seconds, a host that is not on the public internet) never skips: the fire runs and the reason is kept in `last_error`. Manual runs, API runs and inbound-URL runs never consult it. The URL must be https on the default port, with no user name or password, and must not point at a private, loopback or link-local address (400 otherwise); it is fetched with no credentials. Setting a URL forgets what the earlier check remembered. An archived routine answers 409.
idrequiredThe routine id (rtn_…)
urlrequiredprecheckrequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredurlrequiredcreated_atrequiredlast_checked_atrequiredWhen the URL was last checked before a scheduled fire
last_resultrequiredchanged: the fire ran. unchanged: the fire was skipped. failed: the check could not be completed and the fire ran anyway. — "changed" · "unchanged" · "failed" · null
last_errorrequired{type, message} when last_result is failed. Types: address_not_allowed · dns_failed · redirect · http_status · too_large · timeout · network.
{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/precheck \
-H "Authorization: Bearer ast_..."Remove the routine's precheck
idrequiredThe routine id (rtn_…)
removedrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/precheck \
-H "Authorization: Bearer ast_..."The routine's chat trigger
`channel_trigger` is null when there is none. `available` says whether messages of this workspace's connected chats are offered to routines in this deployment; where it is false a trigger can be stored and will never match.
idrequiredThe routine id (rtn_…)
channel_triggerrequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredconnection_idrequiredthread_idrequiredThe one conversation whose messages start a run; null for every conversation on the connection
text_prefixrequiredWhat a message has to start with to start a run; null for every message
created_atrequiredlast_matched_atrequiredavailablerequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/channel-trigger' \
-H "Authorization: Bearer ast_..."Start the routine from a message in a connected chat
A message starts a run when it is on the connection, in `thread_id` when one is given, and starts with `text_prefix` when one is given (leading mentions of the bot and letter case are ignored). Only messages from the person the routine belongs to start a run: the person who connected the chat, or a chat identity they linked to the same account. Anyone else's message is routed as if there were no trigger. The text after the prefix is added to the run's first message under the label "Input for this run:". The run is a task of the routine's creator (trigger_context {type:"channel", connection_id, thread_id}), and when its turn ends its last message is posted, once, in the conversation the message came from, with a link to the run. A message that started a run is sent nowhere else. One message starts at most one run; when several routines match, the one naming a thread and then the longest prefix wins. A paused or archived routine starts nothing, and more than 30 runs of one routine in a minute are dropped. Only the routine's creator can set the trigger (403 otherwise), on a connected chat of their own in this workspace (404 otherwise). `thread_id` must be a conversation on that connection and `text_prefix` 1 to 200 characters (400 otherwise). Setting a trigger replaces the earlier one. An archived routine answers 409.
idrequiredThe routine id (rtn_…)
connection_idrequiredthread_idtext_prefixchannel_triggerrequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredconnection_idrequiredthread_idrequiredThe one conversation whose messages start a run; null for every conversation on the connection
text_prefixrequiredWhat a message has to start with to start a run; null for every message
created_atrequiredlast_matched_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/channel-trigger \
-H "Authorization: Bearer ast_..."Remove the routine's chat trigger
idrequiredThe routine id (rtn_…)
removedrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/channel-trigger \
-H "Authorization: Bearer ast_..."Where the routine's runs post their answer
`deliver_to` is null when the answers are posted nowhere.
idrequiredThe routine id (rtn_…)
deliver_torequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredtyperequired"channel_thread"
connection_idrequiredthread_idrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/deliver-to' \
-H "Authorization: Bearer ast_..."Post each run's answer to a conversation in a connected chat
When a turn of a run's session ends and the run is not waiting on its owner, the last thing the agent said (at most 3,000 characters) is posted in the conversation with a link to the run, once per run. `thread_id` defaults to the chat itself. A run a chat message started answers where that message was instead. Only the routine's creator can set this (403 otherwise), on a connected chat of their own in this workspace (404 otherwise). An archived routine answers 409.
idrequiredThe routine id (rtn_…)
typerequired"channel_thread"
connection_idrequiredthread_iddeliver_torequired▸ Show child attributes▾ Hide child attributes
routine_idrequiredtyperequired"channel_thread"
connection_idrequiredthread_idrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/deliver-to \
-H "Authorization: Bearer ast_..."Stop posting the routine's answers to a conversation
idrequiredThe routine id (rtn_…)
removedrequired{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/routines/sess_cmtb7q2j/deliver-to \
-H "Authorization: Bearer ast_..."Start a run through the routine's inbound URL
No Authorization header: the secret in the path is the credential. The request body, in any format and up to 50,000 characters, is added to the run's first message under the label "Input for this run:"; an empty body starts a run with no input. An `Idempotency-Key` header makes a repeated delivery return the first run. A paused routine answers 409 and starts nothing, an unknown URL or an archived routine answers 404, and more than 30 runs of one routine in a minute answers 429. The run is a task of the routine's owner (trigger_context {type:"api"}).
tokenrequiredThe secret part of the inbound URL (rin_…)
runrequired▸ Show child attributes▾ Hide child attributes
idrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/routines/inbound/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0 \
-H "Authorization: Bearer ast_..."/routine-runsreadList routine runs — every fire attempt
routineFilter to one routine (rtn_…)
has_errortrue = failed runs, false = runs with a session
trigger_typecreated_at[gte]Also gt / lt / lte
cursorlimititemsrequired▸ Show child attributes▾ Hide child attributes
idrrun_… identifier
routine_idtrigger_context{type:"schedule", scheduled_at} | {type:"manual"}
session_iderror{type, message}. Types: agent_archived_error · agent_not_found_error · session_archived_error · session_not_found_error · session_busy_error · environment_archived_error · environment_not_found_error · vault_not_found_error · insufficient_credits_error · rate_limited_error · run_rejected_error · unknown_error. Unrecoverable types auto-pause the routine; transient ones (credits, rate limit, busy) leave it active for the next occurrence. precheck_unchanged is not a failure: the scheduled fire was skipped because the routine's precheck URL returned the same content as at the last run; no session started, the routine stays active and no routine_run webhook is sent.
agentResolved agent reference at fire time
created_atcursorhasMore{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routine-runs' \
-H "Authorization: Bearer ast_..."Routine run detail
idrequiredThe run id (rrun_…)
runrequiredOne fire attempt. Exactly one of session_id / error is non-null.
▸ Show child attributes▾ Hide child attributes
idrrun_… identifier
routine_idtrigger_context{type:"schedule", scheduled_at} | {type:"manual"}
session_iderror{type, message}. Types: agent_archived_error · agent_not_found_error · session_archived_error · session_not_found_error · session_busy_error · environment_archived_error · environment_not_found_error · vault_not_found_error · insufficient_credits_error · rate_limited_error · run_rejected_error · unknown_error. Unrecoverable types auto-pause the routine; transient ones (credits, rate limit, busy) leave it active for the next occurrence. precheck_unchanged is not a failure: the scheduled fire was skipped because the routine's precheck URL returned the same content as at the last run; no session started, the routine stays active and no routine_run webhook is sent.
agentResolved agent reference at fire time
created_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/routine-runs/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."Model subscriptions
List connected model subscriptions — metadata only, never credentials
accountsInclude additional accounts; omitted preserves the legacy provider-only list
modelSubscriptionsrequired▸ Show child attributes▾ Hide child attributes
provider"anthropic" · "openai" · "cursor" · "xai" · "meta"
accountIdAdditional account identifier; omitted for the legacy provider account
labelstatus"connected" · "needs_reconnect"
expiresAtlastUsedAtuseForNewAgentscreatedAtagentsAgents in this universe running on the subscription
▸ Show child attributes▾ Hide child attributes
idagentIdname{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/model-subscriptions' \
-H "Authorization: Bearer ast_..."/model-subscriptionswriteAdd a separate subscription account
credentialrequiredmax length 100000
labelmax length 60
providerrequired"anthropic" · "openai" · "cursor" · "xai" · "meta"
modelSubscriptionrequiredA connected consumer AI subscription (Claude Pro/Max, ChatGPT, Cursor, Grok or Muse plan) powering eligible agents at $0 model usage. The credential itself is write-only.
▸ Show child attributes▾ Hide child attributes
provider"anthropic" · "openai" · "cursor" · "xai" · "meta"
accountIdAdditional account identifier; omitted for the legacy provider account
labelstatus"connected" · "needs_reconnect"
expiresAtlastUsedAtuseForNewAgentscreatedAtagentsAgents in this universe running on the subscription
▸ Show child attributes▾ Hide child attributes
idagentIdname{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/model-subscriptions \
-H "Authorization: Bearer ast_..."Connect or replace a subscription credential (write-only)
anthropic: the sk-ant-oat… token from `claude setup-token`. openai: the contents of ~/.codex/auth.json from `codex login`. cursor: a Cursor API key, or the sign-in file ~/.config/cursor/auth.json from `cursor-agent login`. xai: the sign-in file ~/.grok/auth.json from `grok login`. meta: the sign-in file ~/.config/muse/auth.json from `muse login`. Eligible agents can then run at $0 model usage; with useForNewAgents (default on), new eligible Claude, ChatGPT, Grok and Muse agents use it automatically. Cursor agents use it only when created or switched with modelBilling `account`.
providerrequiredanthropic = Claude subscription · openai = ChatGPT plan · cursor = Cursor plan · xai = Grok subscription · meta = Muse subscription
accountIdTarget an additional account; omitted targets the legacy provider account
credentialrequiredmax length 100000
labelmax length 60
modelSubscriptionrequiredA connected consumer AI subscription (Claude Pro/Max, ChatGPT, Cursor, Grok or Muse plan) powering eligible agents at $0 model usage. The credential itself is write-only.
▸ Show child attributes▾ Hide child attributes
provider"anthropic" · "openai" · "cursor" · "xai" · "meta"
accountIdAdditional account identifier; omitted for the legacy provider account
labelstatus"connected" · "needs_reconnect"
expiresAtlastUsedAtuseForNewAgentscreatedAtagentsAgents in this universe running on the subscription
▸ Show child attributes▾ Hide child attributes
idagentIdname{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/model-subscriptions/provider \
-H "Authorization: Bearer ast_..."Update useForNewAgents / label
providerrequiredanthropic = Claude subscription · openai = ChatGPT plan · cursor = Cursor plan · xai = Grok subscription · meta = Muse subscription
accountIdTarget an additional account; omitted targets the legacy provider account
useForNewAgentslabelmax length 60
modelSubscriptionrequiredA connected consumer AI subscription (Claude Pro/Max, ChatGPT, Cursor, Grok or Muse plan) powering eligible agents at $0 model usage. The credential itself is write-only.
▸ Show child attributes▾ Hide child attributes
provider"anthropic" · "openai" · "cursor" · "xai" · "meta"
accountIdAdditional account identifier; omitted for the legacy provider account
labelstatus"connected" · "needs_reconnect"
expiresAtlastUsedAtuseForNewAgentscreatedAtagentsAgents in this universe running on the subscription
▸ Show child attributes▾ Hide child attributes
idagentIdname{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/model-subscriptions/provider \
-H "Authorization: Bearer ast_..."Disconnect — affected agents keep their pointer and fail until reconnected or switched
providerrequiredanthropic = Claude subscription · openai = ChatGPT plan · cursor = Cursor plan · xai = Grok subscription · meta = Muse subscription
accountIdTarget an additional account; omitted targets the legacy provider account
affectedAgents▸ Show child attributes▾ Hide child attributes
idagentIdname{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/model-subscriptions/provider \
-H "Authorization: Bearer ast_..."External accounts
List the workspace's accounts at outside vendors — never credentials
Vendor accounts connected here, and the workspace's model plans (managed under /model-subscriptions; their ids start with `plan:`). `vendors` lists the vendors an account can be connected for and whether connecting takes one `key` or the vendor's full `settings`. 404 where external accounts are not turned on for the workspace.
external_accountsrequired▸ Show child attributes▾ Hide child attributes
idrequiredkindrequired"model_subscription" · "vendor_account"
vendorrequiredvendor_namerequiredlabelrequiredstatusrequired"active" · "needs_reconnect" · "exhausted"
planrequiredThe plan the vendor reported, when it reports one
agentsrequiredThe agents that have run on it
▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredlast_used_atrequiredcreated_atrequiredvendorsrequired▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredcredentialrequired"key" · "settings"
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/external_accounts' \
-H "Authorization: Bearer ast_..."/external_accountswriteConnect a vendor account, or replace the credential of the one with the same vendor and label
The credential is write-only. Every task of the workspace waiting on this vendor's account (an open `connect_account` request) then continues. 422 `invalid_credential` when the vendor does not accept it; 503 `not_migrated` before the store exists. A vendor's own browser sign-in is not offered here.
vendorrequiredA vendor id from `vendors`
labelDefaults to the vendor's name
credentialrequiredOne key, or the vendor's account settings as upper-case names with text values
▸ Show child attributes▾ Hide child attributes
option 1option 2external_accountrequired▸ Show child attributes▾ Hide child attributes
idrequiredkindrequired"model_subscription" · "vendor_account"
vendorrequiredvendor_namerequiredlabelrequiredstatusrequired"active" · "needs_reconnect" · "exhausted"
planrequiredThe plan the vendor reported, when it reports one
agentsrequiredThe agents that have run on it
▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredlast_used_atrequiredcreated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/external_accounts \
-H "Authorization: Bearer ast_..."Disconnect an account; a later task that needs it asks for it again
idrequiredThe account's id from the list
Disconnected
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/external_accounts/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Which agents and tasks ran on a vendor account
idrequiredThe account's id from the list
usagerequired▸ Show child attributes▾ Hide child attributes
agentsrequired▸ Show child attributes▾ Hide child attributes
idrequirednamerequiredtasksrequired▸ Show child attributes▾ Hide child attributes
session_idrequiredagent_idrequiredtitlerequiredfirst_used_atrequiredlast_used_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/external_accounts/sess_cmtb7q2j/usage' \
-H "Authorization: Bearer ast_..."Connectors
/connectors/appsreadList the apps a person can connect
One page of the catalog. With neither `q` nor `cursor` the page leads with the widely used apps. Pages vary in size: continue with `next_cursor` until it is null. Answers 502 `catalog_error` when the catalog cannot be read.
qSearch by name
cursorA page's `next_cursor`
appsrequired▸ Show child attributes▾ Hide child attributes
slugrequiredThe app's id, used wherever an app is named.
namerequireddescriptionrequirednext_cursorrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/connectors/apps' \
-H "Authorization: Bearer ast_..."List the caller's connections
The accounts the caller connected, by app and then oldest first. Connections belong to the person, not to a workspace. `credit` is what the caller has earned by connecting apps and the most they can earn that way.
connectionsrequired▸ Show child attributes▾ Hide child attributes
idrequiredapprequiredThe app's slug.
app_namerequiredlabelrequiredThe account's name at the app, usually an email address.
created_atrequiredcreditrequired▸ Show child attributes▾ Hide child attributes
earned_usdrequiredcap_usdrequiredgranted_appsrequiredSlugs of the apps that earned credit.
eligible_appsrequiredSlugs of the apps whose connection can earn credit.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/connectors/connections' \
-H "Authorization: Bearer ast_..."Start connecting an app
Answers the address the person's browser opens to sign in to the app and allow access. Afterwards the browser is sent to `success_url`, with `account_id` added to its query, or to `error_url`; the caller then records the result with `POST /connectors/connections/complete`. Both addresses must be https (http is accepted for localhost) and on one origin. Answers 400 `unknown_app` for an app that cannot be connected and 502 `connect_error` when the authorization cannot be started.
apprequiredThe app's slug.
success_urlrequirederror_urlrequiredurlrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/connectors/connections \
-H "Authorization: Bearer ast_..."Record a finished authorization
Call this when the browser arrives at `success_url`. The account is checked against the caller's own accounts at the app's provider, so an account somebody else authorized is refused; without `account_id` the caller's newest account for the app is used. Every task of the caller that was waiting on the app continues. Answers 404 when the caller has no such account and 502 `connect_error` when the provider cannot be read.
apprequiredaccount_idconnectionrequired▸ Show child attributes▾ Hide child attributes
apprequiredapp_namerequiredlabelrequiredcredit_grantrequiredCredit given for this connection, when connecting apps earns credit. `status` is granted, already_granted, cap_reached or ineligible.
▸ Show child attributes▾ Hide child attributes
statusrequiredamount_usdearned_usdcap_usd{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/connectors/connections/complete \
-H "Authorization: Bearer ast_..."Disconnect one of the caller's connections
Agents stop being able to use the account at once. Answers 404 for a connection that is not the caller's.
idrequiredDisconnected
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/connectors/connections/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."List the repositories the caller's GitHub connection can reach
Most recently pushed first, at most 100. Answers 404 `github_not_connected` when the caller has no GitHub connection and 409 `github_reconnect_required` when none of their connections can be used.
reposrequired▸ Show child attributes▾ Hide child attributes
full_namerequireddefault_branchrequiredprivaterequiredpushed_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/connectors/github/repos' \
-H "Authorization: Bearer ast_..."/connectors/linkswriteMake a link to connect the app a task is waiting on
For a task with an open `connect_app` request (see `GET /tasks/{id}`): a link the person the request is addressed to can open in any browser, without being signed in, to connect the app. Only that person can make it. The link can be used once, within fifteen minutes, and this is the only response that carries it; making another replaces one that was not used. When the app is connected the task continues by itself. Answers 404 when the task has no such open request, 403 `request_not_yours` when it is addressed to somebody else, and 503 `not_migrated` until the platform's link table is in place.
task_idrequiredThe task (sess_…)
request_idrequiredlinkrequired▸ Show child attributes▾ Hide child attributes
urlrequiredexpires_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/connectors/links \
-H "Authorization: Bearer ast_..."The page a connect link opens
No Authorization header: the secret in the path is the credential. Answers a page that says what is asked, with a button to continue; looking uses nothing up. A link that is unknown, expired, already used, or whose request is no longer waiting answers the same 404 page. More than 10 requests for one link in a minute answers 429.
tokenrequiredThe secret part of the link (cnl_…)
The page
The link cannot be used
Too many requests for this link
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/connectors/links/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0' \
-H "Authorization: Bearer ast_..."Continue from a connect link to the app's authorization
What the page's button sends. Uses the link up and redirects the browser to the app's sign-in. Refused exactly as the page is.
tokenrequiredRedirect to the app's authorization
The link cannot be used
Too many requests for this link
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/connectors/links/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0 \
-H "Authorization: Bearer ast_..."Where the app's authorization returns for a connect link
The browser arrives here after the person allows access. The connection is recorded for the person the link was made for, once, and the waiting task continues. Only a link that was used, within the last hour, is accepted; anything else answers the 404 page.
tokenrequiredaccount_idConnected
The link cannot be used
The app was not connected
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/connectors/links/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0/done' \
-H "Authorization: Bearer ast_..."Webhooks
/hook_rulesreadThe workspace's hook rules, in evaluation order
`enabled` says whether hook rules are turned on for the workspace; where they are not the list is empty and nothing is evaluated.
enabledrequiredWhether hook rules are turned on for the workspace.
can_editrequiredWhether the caller may replace the rules: they are turned on and the caller owns the workspace.
hook_rulesrequired▸ Show child attributes▾ Hide child attributes
idrequiredhkr_…
pointrequired"session.start" · "tool.call" · "spend" · "turn.end"
matchrequiredactionrequired"notify" · "block" · "require_approval"
webhook_idrequiredenabledrequiredcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/hook_rules' \
-H "Authorization: Bearer ast_..."/hook_ruleswriteReplace the workspace's hook rules (owner only)
The body is the whole ordered list (at most 20); the order is the order of evaluation. A rule sent with the `id` of an existing rule keeps it. Points: `session.start` (a session is about to be created), `tool.call` (a capability call, a call to a connected app, or a tool the gateway runs for a session reached the platform), `spend` (a session's consumed cost reached `match.amount`, whole US cents; read when a turn ends and at a capability call, once per session), `turn.end` (a turn ended). Actions: `notify` delivers a signed event (`hook.session_start`, `hook.tool_call`, `hook.spend`, `hook.turn_end`) to `webhook_id`, one of the workspace's webhook endpoints, whatever events that endpoint subscribed to; never a URL. `block` at `session.start` refuses the session with 403 `blocked_by_hook_rule`; at `tool.call` it refuses the call with `capability_denied` (`reason: hook_rule`). `require_approval` at `tool.call` asks the session's owner exactly as an `ask` capability policy does, and an answer covers one call. `require_approval` at `session.start` creates the session waiting: it has no sandbox and takes no turn (409 `start_not_approved`), and its task carries an `approval` request for the person who created it, answered `confirm` or `decline` through `POST /tasks/{id}/requests/{request_id}/answer`. Approved, it starts with what it was created with; declined, it is archived, never runs and is charged nothing. A session started in a way that cannot wait (a helper, a product run, a handoff) is refused with 403 `blocked_by_hook_rule`. The most restrictive of the matching rules and the capability policies wins. Refused with 400 and the reason: `block` and `require_approval` at `spend` and at `turn.end`. `match` narrows a rule: `{agent_id}` at `session.start` and `turn.end`, `{capability_id}` or `{connector_app}` (the slug of a connected app), not both, at `tool.call`; omitted, the rule applies to all. A notify rule that cannot be delivered never affects the session. 403 `not_enabled` where hook rules are not turned on; 503 `not_migrated` before the tables exist.
rulesrequired▸ Show child attributes▾ Hide child attributes
idAn existing rule's id, to keep it.
pointrequired"session.start" · "tool.call" · "spend" · "turn.end"
actionrequired"notify" · "block" · "require_approval"
match▸ Show child attributes▾ Hide child attributes
agent_idcapability_idconnector_appThe slug of a connected app, e.g. "slack".
amountWhole US cents, e.g. "125" for $1.25. Required at spend.
webhook_idRequired for notify (whep_…); not allowed otherwise.
enabledDefault true.
enabledrequiredWhether hook rules are turned on for the workspace.
can_editrequiredWhether the caller may replace the rules: they are turned on and the caller owns the workspace.
hook_rulesrequired▸ Show child attributes▾ Hide child attributes
idrequiredhkr_…
pointrequired"session.start" · "tool.call" · "spend" · "turn.end"
matchrequiredactionrequired"notify" · "block" · "require_approval"
webhook_idrequiredenabledrequiredcreated_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/hook_rules \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"rules":[{"point":"turn.end","action":"notify","webhook_id":"whep_cmtb2f0a8m9k7x51q4ez6r0d"},{"point":"tool.call","action":"require_approval","match":{"capability_id":"exa.search"}}]}'/webhooksreadList webhook endpoints
webhooksrequired▸ Show child attributes▾ Hide child attributes
idwhep_… identifier
urleventsstatus"active" · "disabled"
failure_countcreated_atsecretwhsec_… — present ONLY in the create response
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/webhooks' \
-H "Authorization: Bearer ast_..."/webhookswriteRegister a webhook endpoint — the whsec_ secret appears only in this response
The URL must be https, with no user name or password, and must not point at a private, loopback or link-local address (400 otherwise). At delivery the host is resolved again: a host that resolves to such an address, and a redirect, are failed attempts.
urlrequiredmax length 2048
eventsrequiredwebhookrequiredOutbound webhook endpoint. Deliveries carry x-asteroids-event/-delivery/-timestamp/-signature (v1=hmac-sha256(secret, "<ts>.<body>")), retry 3× (0s/5s/30s), and sustained failure disables (PATCH status:active re-enables). Payloads are thin {id, type, created_at, data:{type, id}} — fetch the resource, dedupe on the event id.
▸ Show child attributes▾ Hide child attributes
idwhep_… identifier
urleventsstatus"active" · "disabled"
failure_countcreated_atsecretwhsec_… — present ONLY in the create response
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/webhooks \
-H "Authorization: Bearer ast_..." \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/hooks/agentsky","events":["routine_run.failed","routine.paused"]}'/webhooks/{id}readWebhook endpoint detail
idrequiredThe webhook endpoint id (whep_…)
webhookrequiredOutbound webhook endpoint. Deliveries carry x-asteroids-event/-delivery/-timestamp/-signature (v1=hmac-sha256(secret, "<ts>.<body>")), retry 3× (0s/5s/30s), and sustained failure disables (PATCH status:active re-enables). Payloads are thin {id, type, created_at, data:{type, id}} — fetch the resource, dedupe on the event id.
▸ Show child attributes▾ Hide child attributes
idwhep_… identifier
urleventsstatus"active" · "disabled"
failure_countcreated_atsecretwhsec_… — present ONLY in the create response
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/webhooks/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/webhooks/{id}writeUpdate url/events, or status:active to re-enable a disabled endpoint
idrequiredThe webhook endpoint id (whep_…)
urlmax length 2048
eventsstatus"active" · "disabled"
webhookrequiredOutbound webhook endpoint. Deliveries carry x-asteroids-event/-delivery/-timestamp/-signature (v1=hmac-sha256(secret, "<ts>.<body>")), retry 3× (0s/5s/30s), and sustained failure disables (PATCH status:active re-enables). Payloads are thin {id, type, created_at, data:{type, id}} — fetch the resource, dedupe on the event id.
▸ Show child attributes▾ Hide child attributes
idwhep_… identifier
urleventsstatus"active" · "disabled"
failure_countcreated_atsecretwhsec_… — present ONLY in the create response
{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/webhooks/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."/webhooks/{id}writeDelete a webhook endpoint
idrequiredThe webhook endpoint id (whep_…)
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/webhooks/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Apps with sign-in
/oauth_clientsreadThe apps the caller registered
Answers 404 until apps with sign-in are open on the platform.
oauth_clientsrequired▸ Show child attributes▾ Hide child attributes
idrequiredThe client id the app presents when it sends a person to sign in.
namerequiredShown to people when they are asked to allow the app. — max length 80
redirect_urisrequiredWhere the app may send people back after they decide. Matched exactly: no wildcards, no fragments. Must be https; `http://localhost` and `http://127.0.0.1` are accepted while the app is not reviewed.
scopesrequiredWhat the app may ask a person for. `read` sees their tasks, agents and sessions; `write` also starts and changes them. — "read" · "write"
test_usersrequiredPeople besides you who may use the app before it is reviewed, by the email address of their account.
review_statusrequiredAn unreviewed app works only for its owner and its test users, and people are told it has not been reviewed. — "unreviewed" · "approved"
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/oauth_clients' \
-H "Authorization: Bearer ast_..."/oauth_clientswriteRegister an app that signs people in
The app signs a person in with the authorization-code flow and PKCE (S256) at the sign-in service, asking for `openid` plus the scopes registered here and naming this API as the `resource`. The access token it receives is sent as `Authorization: Bearer` to this API. It acts as that person in one workspace: a person who belongs to several chooses it when they allow the app, and the app is refused everywhere else (`universe_mismatch` for another workspace named in `X-Universe`, `not_found` for a session outside it). It holds only the scopes they allowed and reaches tasks, sessions, agents, the catalog and whoami. On a session in that workspace it can also send messages and interrupts (`POST /sessions/{id}/events`, `POST /sessions/{id}/interrupt`, both `write`) and follow the live stream (`GET /sessions/{id}/stream`, `read`). It stops working as soon as the person removes the app from their account page: the next request is refused, and a stream that is open ends within a few seconds. To move the app to another workspace the person removes its access and allows it again. A new app is unreviewed. A caller may register up to 10 apps. Answers 404 until apps with sign-in are open on the platform, and 503 `not_migrated` until its tables are in place.
namerequiredShown to people when they are asked to allow the app. — max length 80
redirect_urisrequiredWhere the app may send people back after they decide. Matched exactly: no wildcards, no fragments. Must be https; `http://localhost` and `http://127.0.0.1` are accepted while the app is not reviewed.
scopesrequiredWhat the app may ask a person for. `read` sees their tasks, agents and sessions; `write` also starts and changes them. — "read" · "write"
test_usersPeople besides you who may use the app before it is reviewed, by the email address of their account.
oauth_clientrequiredAn app registered to sign people in with their account.
▸ Show child attributes▾ Hide child attributes
idrequiredThe client id the app presents when it sends a person to sign in.
namerequiredShown to people when they are asked to allow the app. — max length 80
redirect_urisrequiredWhere the app may send people back after they decide. Matched exactly: no wildcards, no fragments. Must be https; `http://localhost` and `http://127.0.0.1` are accepted while the app is not reviewed.
scopesrequiredWhat the app may ask a person for. `read` sees their tasks, agents and sessions; `write` also starts and changes them. — "read" · "write"
test_usersrequiredPeople besides you who may use the app before it is reviewed, by the email address of their account.
review_statusrequiredAn unreviewed app works only for its owner and its test users, and people are told it has not been reviewed. — "unreviewed" · "approved"
created_atrequiredupdated_atrequiredclient_secretrequiredShown in this response only. Keep it on your server.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/oauth_clients \
-H "Authorization: Bearer ast_..."One of the caller's apps
idrequiredThe app's client id.
oauth_clientrequiredAn app registered to sign people in with their account.
▸ Show child attributes▾ Hide child attributes
idrequiredThe client id the app presents when it sends a person to sign in.
namerequiredShown to people when they are asked to allow the app. — max length 80
redirect_urisrequiredWhere the app may send people back after they decide. Matched exactly: no wildcards, no fragments. Must be https; `http://localhost` and `http://127.0.0.1` are accepted while the app is not reviewed.
scopesrequiredWhat the app may ask a person for. `read` sees their tasks, agents and sessions; `write` also starts and changes them. — "read" · "write"
test_usersrequiredPeople besides you who may use the app before it is reviewed, by the email address of their account.
review_statusrequiredAn unreviewed app works only for its owner and its test users, and people are told it has not been reviewed. — "unreviewed" · "approved"
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/oauth_clients/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/oauth_clients/{id}writeChange one of the caller's apps
Send only the fields to change. Changing the name, the redirect URLs or the scopes of an approved app returns it to unreviewed; changing its test users does not.
idrequiredThe app's client id.
nameShown to people when they are asked to allow the app. — max length 80
redirect_urisWhere the app may send people back after they decide. Matched exactly: no wildcards, no fragments. Must be https; `http://localhost` and `http://127.0.0.1` are accepted while the app is not reviewed.
scopesWhat the app may ask a person for. `read` sees their tasks, agents and sessions; `write` also starts and changes them. — "read" · "write"
test_usersPeople besides you who may use the app before it is reviewed, by the email address of their account.
oauth_clientrequiredAn app registered to sign people in with their account.
▸ Show child attributes▾ Hide child attributes
idrequiredThe client id the app presents when it sends a person to sign in.
namerequiredShown to people when they are asked to allow the app. — max length 80
redirect_urisrequiredWhere the app may send people back after they decide. Matched exactly: no wildcards, no fragments. Must be https; `http://localhost` and `http://127.0.0.1` are accepted while the app is not reviewed.
scopesrequiredWhat the app may ask a person for. `read` sees their tasks, agents and sessions; `write` also starts and changes them. — "read" · "write"
test_usersrequiredPeople besides you who may use the app before it is reviewed, by the email address of their account.
review_statusrequiredAn unreviewed app works only for its owner and its test users, and people are told it has not been reviewed. — "unreviewed" · "approved"
created_atrequiredupdated_atrequired{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/oauth_clients/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."/oauth_clients/{id}writeDelete one of the caller's apps
Everyone's access through the app ends with it.
idrequiredThe app's client id.
Deleted
deleted{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/oauth_clients/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Replace an app's client secret
The previous secret stops working at once. People who already allowed the app keep their access.
idrequiredThe app's client id.
oauth_clientrequiredAn app registered to sign people in with their account.
▸ Show child attributes▾ Hide child attributes
idrequiredThe client id the app presents when it sends a person to sign in.
namerequiredShown to people when they are asked to allow the app. — max length 80
redirect_urisrequiredWhere the app may send people back after they decide. Matched exactly: no wildcards, no fragments. Must be https; `http://localhost` and `http://127.0.0.1` are accepted while the app is not reviewed.
scopesrequiredWhat the app may ask a person for. `read` sees their tasks, agents and sessions; `write` also starts and changes them. — "read" · "write"
test_usersrequiredPeople besides you who may use the app before it is reviewed, by the email address of their account.
review_statusrequiredAn unreviewed app works only for its owner and its test users, and people are told it has not been reviewed. — "unreviewed" · "approved"
created_atrequiredupdated_atrequiredclient_secretrequiredShown in this response only. Keep it on your server.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/oauth_clients/sess_cmtb7q2j/rotate_secret \
-H "Authorization: Bearer ast_..."Channels
/channels/appsreadList BYO channel apps — credentials masked
appsrequired▸ Show child attributes▾ Hide child attributes
verification_errorNon-secret explanation when X verification remains pending
verification_retryablePresent for pending X verification. False means the saved refresh attempt cannot be replayed; replace credentials with a fresh OAuth grant.
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
labelstatuscredential_keysKey names only — values are write-only
created_atsetupSteps the platform cannot automate (per-app webhook_url / verify_token / events_url / invite_url)
registered_platformsrequiredPlatforms with a registered-app writer enabled in this service deployment. Does not prove customer credentials or provider delivery.
shared_platformsrequiredShared bot choices supported by app selection in this deployment; does not inventory the legacy shared channel flows.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/apps' \
-H "Authorization: Bearer ast_..."/channels/appswriteRegister your own bot/number as a channel app
Credentials are proven against the platform where an API exists, stored encrypted, and write-only from then on. The response's setup object carries the steps the platform cannot automate (webhook URLs to paste, invite links).
platformrequired"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
labelrequiredmax length 120
credentialsrequiredWrite-only. Required keys per platform — telegram: bot_token · discord: bot_token · slack: bot_token, signing_secret · whatsapp: access_token, phone_number_id, app_secret · email (requires EMAIL_CHANNEL_ENABLED): region, access_key, secret_key, from_address, sns_topic_arn; optional from_name, inbound_address, allow_subaddressing, reply_to_sender_only (string true/false); optional s3_bucket, s3_prefix (nonempty, ends /), s3_bucket_owner (12 digits), all three together for S3 receiving with the same region/key pair · teams (when enabled; app creation and credential rotation return 501 coming_soon when disabled): app_id (Azure Application client ID), app_password (client secret); optional app_tenant_id (Directory ID for single-tenant bots, omit for multi-tenant). Credentials are validated against Azure AD on creation. The API returns a webhook_url to paste into Azure Bot Configuration → Messaging Endpoint. Connection returns PENDING and a LINK code to send to the bot. Each conversation can bind to its own session. · imessage (coming soon — answers 501 coming_soon today): api_key, phone_number, webhook_secret · x: consumer_secret + either user_access_token (Group A, OAuth 2.0 Bearer) or client_id + refresh_token (Group B, OAuth 2.0 managed refresh). Exactly one group must be supplied. · lark: app_id, app_secret, verification_token (optional encrypt_key, domain: lark|feishu, app_mode: self-built|store, app_ticket for migration) · buzz: private_key, auth_tag · gchat: service_account_json, project_number · line: channel_access_token, channel_secret (requires LINE_CHANNEL_ENABLED; setup returns manual webhook instructions)
verification_errorNon-secret explanation when X verification remains pending
verification_retryablePresent for pending X verification. False means the saved refresh attempt cannot be replayed; replace credentials with a fresh OAuth grant.
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
labelstatuscredential_keysKey names only — values are write-only
created_atsetupSteps the platform cannot automate (per-app webhook_url / verify_token / events_url / invite_url)
Verification pending
verification_errorNon-secret explanation when X verification remains pending
verification_retryablePresent for pending X verification. False means the saved refresh attempt cannot be replayed; replace credentials with a fresh OAuth grant.
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
labelstatuscredential_keysKey names only — values are write-only
created_atsetupSteps the platform cannot automate (per-app webhook_url / verify_token / events_url / invite_url)
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/apps \
-H "Authorization: Bearer ast_..."Channel app detail — credentials masked
idrequiredThe channel app id
verification_errorNon-secret explanation when X verification remains pending
verification_retryablePresent for pending X verification. False means the saved refresh attempt cannot be replayed; replace credentials with a fresh OAuth grant.
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
labelstatuscredential_keysKey names only — values are write-only
created_atsetupSteps the platform cannot automate (per-app webhook_url / verify_token / events_url / invite_url)
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/apps/sess_cmtb7q2j' \
-H "Authorization: Bearer ast_..."/channels/apps/{id}writeRename or rotate credentials (rotation re-runs registration)
idrequiredThe channel app id
retry_registrationRetry saved X verification without resubmitting credentials; mutually exclusive with credentials
labelmax length 120
credentialsFull replacement bag; rotation re-runs the platform registration
verification_errorNon-secret explanation when X verification remains pending
verification_retryablePresent for pending X verification. False means the saved refresh attempt cannot be replayed; replace credentials with a fresh OAuth grant.
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
labelstatuscredential_keysKey names only — values are write-only
created_atsetupSteps the platform cannot automate (per-app webhook_url / verify_token / events_url / invite_url)
Verification pending
verification_errorNon-secret explanation when X verification remains pending
verification_retryablePresent for pending X verification. False means the saved refresh attempt cannot be replayed; replace credentials with a fresh OAuth grant.
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
labelstatuscredential_keysKey names only — values are write-only
created_atsetupSteps the platform cannot automate (per-app webhook_url / verify_token / events_url / invite_url)
{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/channels/apps/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."/channels/apps/{id}writeDelete the channel app
idrequiredThe channel app id
Deleted
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/channels/apps/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."List connections with their bound session
connectionsrequired▸ Show child attributes▾ Hide child attributes
idplatformchannel_idthread_idPresent after administrative adoption; the existing app-scoped reply address
labelstatus"PENDING" · "CONNECTED" · "DISCONNECTED"
bound_session▸ Show child attributes▾ Hide child attributes
idlabelcreated_atconnectPENDING only: open url; X and webhook-based Slack/Discord use a hosted page, phone-based flows include phone + code, and Lark includes app_id and a code to send to the bot.
▸ Show child attributes▾ Hide child attributes
urlphoneapp_idLark app ID used to open the bot
codeexpires_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/connections' \
-H "Authorization: Bearer ast_..."Connect a surface — link-flow platforms return a pending connect ceremony
telegram/imessage/whatsapp/x/lark/gchat mint a connect ceremony (hosted page or deep link + code) the end user claims in-platform. Slack/Discord with destination.webhook return a LINK ceremony; other Slack/Discord flows create a channel synchronously. Pass app for BYO; callback_url (link flows) redirects the hosted connect page to you after the claim.
platformrequired"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line" · "loopback"
labelmax length 120
metadataEchoed on channel.connected and the callback redirect
destinationPre-bind to exactly one owned session or webhook endpoint when the surface is claimed
▸ Show child attributes▾ Hide child attributes
sessionwebhookappBYO ChannelApp id — the connect ceremony runs on your bot/number
adoptAdmin-scope migration of the app owner's previously verified conversation. Requires an owned active app, an app-scoped thread ID and destination. The caller attests the existing sender binding and consent; no LINK ceremony or provider message is performed. Exact replay reuses the connection; changed sender, metadata, destination or a disconnected record returns 409. Cannot combine with callback_url or invite_user.
▸ Show child attributes▾ Hide child attributes
thread_idrequiredmax length 8192
author_idrequiredmax length 1024
tenant_keyRequired only for Lark Store adoption; provider app and chat state must confirm this organization. — max length 256
invite_userSlack only: user id to invite into the created channel
callback_urlLink-flow platforms only: the hosted connect page redirects here after the claim with connection_id, status, and metadata query params
idplatformchannel_idthread_idPresent after administrative adoption; the existing app-scoped reply address
labelstatus"PENDING" · "CONNECTED" · "DISCONNECTED"
bound_session▸ Show child attributes▾ Hide child attributes
idlabelcreated_atconnectPENDING only: open url; X and webhook-based Slack/Discord use a hosted page, phone-based flows include phone + code, and Lark includes app_id and a code to send to the bot.
▸ Show child attributes▾ Hide child attributes
urlphoneapp_idLark app ID used to open the bot
codeexpires_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/connections \
-H "Authorization: Bearer ast_..."Read your connection claim's current status
Look up a link-flow ceremony by its 32-character token, scoped to the authenticated owner and universe. Reconnecting an existing conversation can replace the pending connection ID; this returns the effective ID. It does not confirm downstream webhook processing. Responses are not cached. Normal API rate limits apply; back off on 429.
tokenrequiredThe token after LINK: or in the Telegram start parameter
statusrequired"pending" · "connected" · "expired" · "disconnected"
connection_idrequiredplatformrequiredmetadatarequiredThe caller's original connection metadata
expires_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/connections/status?token=Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0' \
-H "Authorization: Bearer ast_..."Disconnect the surface
idrequiredThe connection id
Disconnected
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/channels/connections/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Set where the surface routes — a session or your webhook endpoint (single active binding)
idrequiredThe connection id
destinationrequiredExactly one of webhook (endpoint id) or session (session id)
▸ Show child attributes▾ Hide child attributes
webhooksessionconnection_idbinding_idsessionwebhook{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/channels/connections/sess_cmtb7q2j/binding \
-H "Authorization: Bearer ast_..."Declared platform capabilities — branch on these instead of guessing
idrequiredThe connection id
connection_idplatformcapabilitiesthreads · reactions · markers · proactive · markdown · modals · ephemeral · streaming · files
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/connections/sess_cmtb7q2j/capabilities' \
-H "Authorization: Bearer ast_..."Inject a message into a loopback connection
Local development without a real platform: the message goes through the same webhook pipeline a Telegram or Slack event would. Only loopback connections accept it — anything else answers 400.
idrequiredThe connection id
textrequiredthreadThread key within the connection; default "main"
idMessage id to attribute it to; default a generated one
author▸ Show child attributes▾ Hide child attributes
user_idrequireduser_namementionWhether it reads as a mention of the bot
thread_idrequired{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/connections/sess_cmtb7q2j/dev/inbound \
-H "Authorization: Bearer ast_..."Everything the agent has sent on a loopback connection
The counterpart to dev/inbound: what a real platform would have received.
idrequiredThe connection id
outboundrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/connections/sess_cmtb7q2j/dev/outbound' \
-H "Authorization: Bearer ast_..."List bindings, optionally by connection
connection_idbindingsrequired▸ Show child attributes▾ Hide child attributes
idconnection_idthread_iddestinationExactly one of webhook (endpoint id) or session (session id)
▸ Show child attributes▾ Hide child attributes
webhooksessionis_defaultstatusroute_key{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/bindings' \
-H "Authorization: Bearer ast_..."/channels/bindingswriteRoute one thread of a connection to a session or your webhook
connection_idrequiredthread_idrequiredThe one thread this rule routes. Connection-level routing is a single slot — set it via PUT /connections/{id}/binding
destinationrequiredExactly one of webhook (endpoint id) or session (session id)
▸ Show child attributes▾ Hide child attributes
webhooksessionroute_keymax length 60
idconnection_idthread_iddestinationExactly one of webhook (endpoint id) or session (session id)
▸ Show child attributes▾ Hide child attributes
webhooksessionis_defaultstatusroute_key{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/bindings \
-H "Authorization: Bearer ast_..."Delete the binding
idrequiredThe binding id
Deleted
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/channels/bindings/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."List the chat identities linked to your account
identitiesrequired▸ Show child attributes▾ Hide child attributes
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
external_user_idThe person's id on that platform
display_namelinked_at{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/identities' \
-H "Authorization: Bearer ast_..."/channels/identitieswriteComplete a link offered to a person in a connected chat, as the caller
From then on that person's messages in conversations on the same bot or workspace run as the caller's account. The token is the one posted in the chat; it works once and for 30 minutes. 404 when it was used or has expired, 503 `not_migrated` until the platform's tables are in place.
tokenrequiredLinked
identityrequiredA person in a connected chat, linked to the account their messages there run as.
▸ Show child attributes▾ Hide child attributes
idplatform"telegram" · "slack" · "discord" · "whatsapp" · "imessage" · "email" · "teams" · "x" · "lark" · "buzz" · "gchat" · "line"
external_user_idThe person's id on that platform
display_namelinked_at{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/identities \
-H "Authorization: Bearer ast_..."Read who a link would connect, before completing it
tokenrequiredThe link token posted in the chat
linkrequired{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/identities/links/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0' \
-H "Authorization: Bearer ast_..."Unlink a chat identity; that person's messages stop running as you
idrequiredThe identity id
Unlinked
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/channels/identities/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."List webhook endpoints
webhooksrequired▸ Show child attributes▾ Hide child attributes
idurleventsstatussecretwhsec_ HMAC secret — returned on create only
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/channels/webhooks' \
-H "Authorization: Bearer ast_..."/channels/webhookswriteCreate a webhook endpoint — HMAC-signed deliveries, 0/5/30s retries
Deliveries carry X-Asteroids-{Event,Delivery,Timestamp,Signature}; ~20 consecutive failures disable the endpoint. Consumers must be idempotent by delivery id. The message.received payload is described by ChannelMessageReceived, including its optional service-owned claim.
urlrequiredhttps (http allowed for localhost only)
eventsDefault ["message.received"]
idurleventsstatussecretwhsec_ HMAC secret — returned on create only
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/webhooks \
-H "Authorization: Bearer ast_..."Re-enable a disabled endpoint (resets failures, keeps the secret) and/or re-pick events
idrequiredThe webhook endpoint id
status"ACTIVE"
eventsidurleventsstatussecretwhsec_ HMAC secret — returned on create only
{ "error": { "code", "message" } } — see the error table above.curl -X PATCH https://api.agentsky.dev/v1/channels/webhooks/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Delete the webhook endpoint
idrequiredThe webhook endpoint id
Deleted
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/channels/webhooks/sess_cmtb7q2j \
-H "Authorization: Bearer ast_..."Post into a thread — markdown renders natively per platform
File parts use owned Files API assets and require capabilities.files. Long replies are split into complete platform-sized messages. Supply idempotency_key to avoid duplicate sends on retry; an uncertain or partial send must be inspected before choosing a new key. done and failed are mutually exclusive.
idrequiredThe thread id (from message.received or channel events)
partsrequired▸ Show child attributes▾ Hide child attributes
type: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredA visible, unexpired Files API upload or session output; requires capabilities.files. — pattern ^file_[A-Za-z0-9_-]{1,128}$
type: "text"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "markdown"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "raw"▸ Show child attributes▾ Hide child attributes
typerequiredplatformrequiredpayloadrequiredPlatform-native payload, JSON-encoded
emailSES-only headers. The authorized thread owns the recipient; this object cannot change To.
▸ Show child attributes▾ Hide child attributes
subjectmax length 200 — pattern ^[^\r\n]+$
reply_toidempotency_keyDurable replay key scoped to the persisted owner, connection and thread, independent of bearer token scope. Same-content replays return the accepted receipt even after disconnect; changed content or an unconfirmed send returns 409 without resending. — max length 200
doneResolves the working marker as successful; cannot be true with failed
failedResolves the working marker as failed; cannot be true with done
message_idthread_id{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/threads/sess_cmtb7q2j/messages \
-H "Authorization: Bearer ast_..."Add a reaction (platform-neutral emoji names)
idrequiredThe thread id
midrequiredemojirequiredReacted
{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/channels/threads/sess_cmtb7q2j/messages/mid/reactions/emoji \
-H "Authorization: Bearer ast_..."Remove a reaction
idrequiredThe thread id
midrequiredemojirequiredRemoved
{ "error": { "code", "message" } } — see the error table above.curl -X DELETE https://api.agentsky.dev/v1/channels/threads/sess_cmtb7q2j/messages/mid/reactions/emoji \
-H "Authorization: Bearer ast_..."/channels/deliverieswriteProactive fan-out: post to every thread bound to a destination
destinationrequiredExactly one of webhook (endpoint id) or session (session id)
▸ Show child attributes▾ Hide child attributes
webhooksessionpartsrequired▸ Show child attributes▾ Hide child attributes
type: "file"▸ Show child attributes▾ Hide child attributes
typerequiredfile_idrequiredA visible, unexpired Files API upload or session output; requires capabilities.files. — pattern ^file_[A-Za-z0-9_-]{1,128}$
type: "text"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "markdown"▸ Show child attributes▾ Hide child attributes
typerequiredtextrequiredtype: "raw"▸ Show child attributes▾ Hide child attributes
typerequiredplatformrequiredpayloadrequiredPlatform-native payload, JSON-encoded
doneResolves each working marker as successful; cannot be true with failed
failedResolves each working marker as failed; cannot be true with done
OK — per-thread results
results▸ Show child attributes▾ Hide child attributes
thread_idstatus{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/channels/deliveries \
-H "Authorization: Bearer ast_..."SSE mirror of your webhook events — for local development
SSE stream
{ "error": { "code", "message" } } — see the error table above.curl -N 'https://api.agentsky.dev/v1/channels/events/stream' \
-H "Authorization: Bearer ast_..."White label
The onboarding instruction for this account
Markdown by default (the reader is a language model); `?format=json` returns the same state as fields. It describes the step this account is actually on, so an agent can fetch it, make the call it names, and fetch it again until it reports the account is live. This is the entry point for white-label onboarding — there is no form.
formatThe instruction
state"unapplied" · "waiting" · "rejected" · "setting_up" · "live" · "suspended"
next_actionThe one call that advances onboarding; null when nothing does.
outstandingpartner{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/partner/onboarding' \
-H "Authorization: Bearer ast_..."/partnerreadWhere this account stands
state"unapplied" · "waiting" · "rejected" · "setting_up" · "live" · "suspended"
next_actionThe one call that advances onboarding; null when nothing does.
outstandingpartner{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/partner' \
-H "Authorization: Bearer ast_..."/partner/applicationwriteAsk to become a white-label partner
A request, not a switch: a person here reads it and decides, and no call advances it in the meantime. One open application per account.
productNamerequiredWhat this partner's customers will call the product.
intendedHostrequiredAdvisory at this stage; hostnames are claimed later.
notesAccepted for a decision
application_idstatenext_actionmessage{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/partner/application \
-H "Authorization: Bearer ast_..."/partner/key-prefixadminClaim the prefix this partner's API keys carry
The visible half of every key their customers hold: `acme_…` rather than `ast_…`. Changeable only while no keys exist under it — after that, changing it would strand them.
prefixrequired2–8 lowercase letters or digits, starting with a letter.
Claimed
partner▸ Show child attributes▾ Hide child attributes
idslugnamestatus"pending" · "active" · "suspended"
key_prefixNull until claimed.
brandbrand_missingBrand fields still falling back to ours.
rate_limit_per_minhostname_quotahostnames▸ Show child attributes▾ Hide child attributes
hostnameplane"API" · "GATEWAY" · "APP" · "ACCOUNTS" · "STUDIO_POOL" · "STUDIO_WILDCARD"
ssl_statusservingOnly a serving hostname counts toward going live.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/partner/key-prefix \
-H "Authorization: Bearer ast_..."/partner/domainsadminClaim a hostname for one plane
The response leads with the CNAME a person must add at the partner's own registrar — the one step of onboarding nobody on our side can do. Adding the row is not ownership: nothing routes until domain-control validation issues a certificate.
hostnamerequiredplanerequired"API" · "GATEWAY" · "APP" · "ACCOUNTS" · "STUDIO_POOL"
Claimed, pending DNS
dns_recordnext_actionpartner▸ Show child attributes▾ Hide child attributes
idslugnamestatus"pending" · "active" · "suspended"
key_prefixNull until claimed.
brandbrand_missingBrand fields still falling back to ours.
rate_limit_per_minhostname_quotahostnames▸ Show child attributes▾ Hide child attributes
hostnameplane"API" · "GATEWAY" · "APP" · "ACCOUNTS" · "STUDIO_POOL" · "STUDIO_WILDCARD"
ssl_statusservingOnly a serving hostname counts toward going live.
{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/partner/domains \
-H "Authorization: Bearer ast_..."/partner/brandadminSet the names and copy this partner's customers see
All fields together. A partial brand is refused rather than half-applied: every field left unset falls back to a platform value carrying our name, which would reach their customer.
productNamerequiredrequestIdHeaderrequiredWritten into responses verbatim; must look like x-something.
spendGateHeaderrequiredMust look like x-something.
spendGateMessagerequiredWhat this partner's customer reads when their balance is empty.
billingUrlrequireddocsUrlrequiredsupportUrlrequiredframeAncestorsrequiredA bare https origin naming one of this partner's own hostnames — it becomes the CSP on their customers' session pages.
Saved
partner▸ Show child attributes▾ Hide child attributes
idslugnamestatus"pending" · "active" · "suspended"
key_prefixNull until claimed.
brandbrand_missingBrand fields still falling back to ours.
rate_limit_per_minhostname_quotahostnames▸ Show child attributes▾ Hide child attributes
hostnameplane"API" · "GATEWAY" · "APP" · "ACCOUNTS" · "STUDIO_POOL" · "STUDIO_WILDCARD"
ssl_statusservingOnly a serving hostname counts toward going live.
{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/partner/brand \
-H "Authorization: Bearer ast_..."/partner/sitereadWhat this partner has set for its own hostnames
site▸ Show child attributes▾ Hide child attributes
brandhelpers"all", or the handles agents in this partner's workspaces may hire. — "all"
agentsThe handles of this partner's own agents: the only ones its hostnames list.
only_hereThose of `agents` that are listed on this partner's hostnames and nowhere else. The rest also appear in the general catalog once approved.
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/partner/site' \
-H "Authorization: Bearer ast_..."/partner/siteadminSet how the product looks, which helpers may be hired, and which agents are this partner's
Send any of `brand`, `helpers` and `agents`; a part left out is left as it is. `brand` is replaced whole, or cleared with null. A person who signs up on one of this partner's hostnames gets a workspace that counts as the partner's: those hostnames list only the agents named in `agents`, and agents in those workspaces may hire only the helpers `helpers` allows (a refused hire answers 403 `helper_not_allowed`). 422 `refused` says in words what was wrong.
brandhelpers"all"
agentsEach must be a listing in a workspace this partner's owner owns.
only_hereReplaces the list whole. Each must be one of `agents`. Refused 422 while this partner's hostnames are not switched on.
Saved
site▸ Show child attributes▾ Hide child attributes
brandhelpers"all", or the handles agents in this partner's workspaces may hire. — "all"
agentsThe handles of this partner's own agents: the only ones its hostnames list.
only_hereThose of `agents` that are listed on this partner's hostnames and nowhere else. The rest also appear in the general catalog once approved.
{ "error": { "code", "message" } } — see the error table above.curl -X PUT https://api.agentsky.dev/v1/partner/site \
-H "Authorization: Bearer ast_..."Invites
/invites/{token}readWhat an invitation link offers the signed-in person
status is open (this account may join), joined, wrong_email (sent to a different address) or closed (used, withdrawn or expired).
tokenrequiredThe token from the invitation link
workspace▸ Show child attributes▾ Hide child attributes
slugnameinvited_byrole"admin" · "member"
emailstatus"open" · "joined" · "wrong_email" · "closed"
{ "error": { "code", "message" } } — see the error table above.curl 'https://api.agentsky.dev/v1/invites/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0' \
-H "Authorization: Bearer ast_..."/invites/{token}writeJoin the workspace through an invitation link
Only an account signed in with the invited, verified email may join; a credential limited to one workspace cannot.
tokenrequiredworkspace▸ Show child attributes▾ Hide child attributes
slugname{ "error": { "code", "message" } } — see the error table above.curl -X POST https://api.agentsky.dev/v1/invites/Yy5oaLAHSF5t96EAi9FiEk7uTjLMxNWDVHK8UPr1zK0 \
-H "Authorization: Bearer ast_..."Stream events
Send and listen are decoupled: POST …/events, then read …/stream until session.status_idle — there is no non-streaming reply mode. Frames are id: + event: + one data: JSON object { id, type, sessionId, agent, at, …payload } (the id is the dedupe key against GET …/events):
| event | payload | meaning |
|---|---|---|
user.message | content | history only (GET …/events) and the POST echo — user messages are not sent on the live stream; content is the CMA block list you sent, every image/document source rewritten to a file source |
system.message | content | history only and the POST echo — the per-turn system text sent alongside a user.message |
user.interrupt | by | an interrupt was accepted — echoed on the live stream and kept in history; the pod's session.status_idle follows |
agent.message | parts, text | a user-facing agent post; a turn may carry several |
agent.reasoning | part | raw engine event: thinking (live only) |
agent.tool_use | part | raw engine event: a tool invocation (live only) |
agent.tool_result | part | raw engine event: the tool's outcome (live only) |
agent.status | part | raw engine event: working / waiting / … (live only) |
session.status_running | — | a turn started |
session.status_idle | stop_reason | the turn is over (stop_reason.type is end_turn — also after an interrupt — budget_reached, retries_exhausted after an exhausted engine error, or provider_lost after a confirmed runtime Pod loss); never break on bare idle; the stream stays open |
session.error | error | a failure inside the turn (error.type, error.message, error.retry_status retrying or exhausted); the stream stays open and a session.status_idle follows |
session.status_terminated | — | the session was archived; terminal — nothing follows; close the stream |
session.deleted | — | terminal — nothing follows; close the stream |
id: msg-77e0c4…
event: agent.message
data: {"id":"msg-77e0c4…","type":"agent.message","sessionId":"sess-8c41f0…","agent":"nemesis-ee87","at":"…","text":"Signups today: 42, up 12%.","parts":[…]}
id: api-user-9d52a1…#idle
event: session.status_idle
data: {"id":"api-user-9d52a1…#idle","type":"session.status_idle","sessionId":"sess-8c41f0…","agent":"nemesis-ee87","at":"…","stop_reason":{"type":"end_turn"}}