session.claims.create

create(body: CreateClaimRequest, options?: IdempotentRequestOptions): Promise<Claim>

Carries an idempotency key. Retried on network failure, timeout, 429, and 409 idempotency.in_progress - never on a 5xx.

Example

const result = await session.claims.create({
  to: "0x1111111111111111111111111111111111111111",
});

string

required

string

required

Recipient address.

'endstate_relay' | 'client_broadcast'

endstate_relay submits the claim for you. client_broadcast returns a claim payload for you to submit.

201 - Claim.

string

required

string

required

string

required

string

required

'claiming' | 'claimed' | 'expired' | 'failed'

required

object | null

string

required

Branch on error.code, never on the HTTP status - several codes share one.

Code	HTTP	Retry
`auth.forbidden`	403	Do not retry
`auth.unauthorized`	401	Do not retry
`claim.already_to_recipient`	409	Do not retry
`claim.in_progress`	409	Poll the resource
`claim.owner_unknown`	409	Wait, then retry
`idempotency.in_progress`	409	Safe to retry
`idempotency.key_conflict`	409	Do not retry
`internal.error`	500	Safe to retry
`rate_limit.exceeded`	429	Safe to retry
`session_token.invalid_or_expired`	401	Do not retry
`session_token.wrong_chip`	403	Do not retry
`unit.not_found`	404	Do not retry
`unit.not_minted`	409	Poll the resource
`validation.failed`	400	Do not retry

See Errors and retries for the error types and how to narrow them.