Claim

Claim a public resource

Assigns a publicly-created resource to the caller's organization using its one-time `claim_token`. Requires an API key.

POST/api/claim/{id}

Parameters

Path

idstringrequired

The ID of the public resource to claim (tsk_…, wh_…, art_…, msg_…, or inbox_…).

Request body

claim_tokenstringrequired

Responses

200The claimed resource, now owned by the caller's organization.

One of the following objects:

Task

idstring

Unique identifier for the task, prefixed with `tsk_`.Example: "tsk_xxxxxxxxxxxxxxxxxxxxxxxx"

object"task"

organization_idstring | null

Owning organization ID, or null if the resource is public (created without an API key).

namestring

descriptionstring | null

priority"low" | "medium" | "high" | "critical"

Task priority. Defaults to `low`.

due_atinteger | null

When the task is due. Unix timestamp in seconds.

labelsstring[]

Labels attached to the task. Use ?label= on the list endpoint to filter. Defaults to [].

created_atinteger | null

When the task was created. Unix timestamp in seconds.

updated_atinteger | null

When the task was last updated. Unix timestamp in seconds.

WebhookEndpoint

idstring

Unique identifier for the webhook endpoint, prefixed with `wh_`.Example: "wh_xxxxxxxxxxxxxxxxxxxxxxxx"

object"webhook_endpoint"

organization_idstring | null

Owning organization ID, or null if the resource is public (created without an API key).

namestring

descriptionstring | null

urlstring

Public capture URL (…/api/catch/{id}) that records requests.

max_eventsinteger

Maximum number of events retained. Defaults to 100.

event_countinteger

Number of captured events. Present on single-resource reads.

created_atinteger | null

When the endpoint was created. Unix timestamp in seconds.

updated_atinteger | null

When the endpoint was last updated. Unix timestamp in seconds.

Inbox

idstring

Unique identifier for the inbox, prefixed with `inbox_`.Example: "inbox_xxxxxxxxxxxxxxxxxxxxxxxx"

object"inbox"

organization_idstring | null

Owning organization ID, or null if the resource is public (created without an API key).

namestring

descriptionstring | null

ingest_urlstring

Public ingest URL (…/api/inboxes/{id}/events). Anyone with the ID can POST events here — no authentication required.

default_ttl_secondsinteger

Default event TTL in seconds, used when an ingested event doesn't specify its own. Defaults to 86400 (1 day); range 60–2592000 (30 days).

max_eventsinteger

Maximum number of pending (non-expired) events retained. Defaults to 1000.

event_countinteger

Number of pending (non-expired) events. Present on single-resource reads.

created_atinteger | null

When the inbox was created. Unix timestamp in seconds.

updated_atinteger | null

When the inbox was last updated. Unix timestamp in seconds.

Artifact

idstring

Unique identifier for the artifact, prefixed with `art_`.Example: "art_xxxxxxxxxxxxxxxxxxxxxxxx"

object"artifact"

organization_idstring | null

Owning organization ID, or null if the resource is public (created without an API key).

namestring

sizeinteger

Size of the stored content in bytes (UTF-8).

contentstring

The stored content. Returned when fetching a single artifact; omitted from list responses — use `raw_url` to fetch the body.

format"markdown" | "html"

Content format. Determines the content type the raw endpoint serves.

raw_urlstring

Path serving the raw content with the format's content type (`text/html` for html, `text/markdown` for markdown).

created_atinteger | null

When the artifact was created. Unix timestamp in seconds.

updated_atinteger | null

When the artifact was last updated. Unix timestamp in seconds.

ScheduledMessage

idstring

Unique identifier for the scheduled message, prefixed with `msg_`.Example: "msg_xxxxxxxxxxxxxxxxxxxxxxxx"

object"scheduled_message"

organization_idstring | null

Owning organization ID, or null if the resource is public (created without an API key).

channel"http"

Delivery channel. Only `http` is supported today.

urlstring

Target URL the request is sent to.

method"GET" | "POST" | "PUT" | "PATCH" | "DELETE"

HTTP method used for delivery.

headersobject

Request headers. Defaults to {}.

bodystring | null

Request body, if any.

scheduled_atinteger | null

When the message will fire. Unix timestamp in seconds.

status"scheduled" | "delivering" | "delivered" | "failed" | "canceled"

Delivery state.

attemptsinteger

Number of delivery attempts made.

response_statusinteger | null

HTTP status returned by the target on the last attempt.

last_errorstring | null

Error from the last attempt, if it failed.

delivered_atinteger | null

When the last delivery attempt ran. Unix timestamp in seconds.

created_atinteger | null

When the message was created. Unix timestamp in seconds.

updated_atinteger | null

When the message was last updated. Unix timestamp in seconds.

400The request was malformed or failed validation.

errorobject

codestring

Machine-readable error code.

messagestring

Human-readable error message.

paramstring | null

The offending parameter, when applicable.

401No valid API key was provided.

errorobject

codestring

Machine-readable error code.

messagestring

Human-readable error message.

paramstring | null

The offending parameter, when applicable.

403The caller is authenticated but lacks access to the resource.

errorobject

codestring

Machine-readable error code.

messagestring

Human-readable error message.

paramstring | null

The offending parameter, when applicable.

404The resource does not exist or is not visible to the caller.

errorobject

codestring

Machine-readable error code.

messagestring

Human-readable error message.

paramstring | null

The offending parameter, when applicable.

Example request

curl

curl -X POST https://agtls.dev/api/claim/{id} \
  -H "Authorization: Bearer agt_…" \
  -H "Content-Type: application/json" \
  -d '{ … }'