Browse documentation
← API reference

Test checks

Ask to sign your test acceptance with a passkey

POST /api/v1/tests/acceptances

Send the protected signer request produced by the CLI for an in-toto test-acceptance statement. The payload and its DSSE pre-authentication encoding must agree and name the signed-in person and current acceptance key. Open confirmation.url for that person to review and confirm with their passkey. Poll the returned confirmation ID at GET /api/v1/tests/acceptances/{id}; only the confirmed, exact bytes get a signed envelope. The request expires after five minutes.

Parameters

Idempotency-Keyheader · optional · string

Makes a retry safe: a request with the same key and the same method, path, and body as an earlier one gets the earlier response instead of doing the work again. 1 to 255 visible ASCII characters; use a new key for each new request, such as a UUID. Keys are kept per caller for a day, and ignored for requests without credentials.

Minimum length: 1 · Maximum length: 255

Example request

curl --request POST 'https://commitscale.com/api/v1/tests/acceptances' \
  --header "Authorization: Bearer $CSCALE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "by": "user:alex",
  "keyid": "acceptance-2026-10",
  "pae": "RFNTRXYxIDI4IGFwcGxpY2F0aW9uL3ZuZC5pbi10b3RvK2pzb24gNDMgeyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEifQ==",
  "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEifQ==",
  "payloadType": "application/vnd.in-toto+json",
  "purpose": "test-acceptance",
  "version": 1
}'

Example values illustrate the format. Use your own credentials and identifiers.

Request body

application/json

The protected signature request. The payload and PAE must agree.

byrequired · string

The signed-in person's handle, also present in the statement.

keyidrequired · string

Identifier of the verification key. Pin it with the server and person you trust.

paerequired · string

DSSE pre-authentication encoding of those bytes, in standard base64.

payloadrequired · string

The exact in-toto statement bytes, in standard base64.

payloadTyperequired · string

DSSE payload type: application/vnd.in-toto+json.

purposerequired · string

Signature purpose. Send test-acceptance.

versionrequired · integer (int32)

Protected signer protocol version. Send 1.

Minimum: 0

Responses

200 Waiting for your passkey, for five minutes.

application/json

{
  "confirmation": {
    "action": "create_check_key",
    "confirmed_at": "2026-10-26T10:00:00Z",
    "created_at": "2026-10-26T10:00:00Z",
    "expires_at": "2026-10-26T10:00:00Z",
    "id": "019a1f40-7c00-7000-8000-000000000004",
    "person": "user:alex",
    "title": "Create a check key",
    "url": "https://commitscale.com/confirm/019a1f40-7c00-7000-8000-000000000004"
  },
  "envelope": {
    "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEifQ==",
    "payloadType": "application/vnd.in-toto+json",
    "signatures": [
      {
        "keyid": "acceptance-2026-10",
        "sig": "AQIDBAUGBwgJCgsMDQ4PEBESExQVFhcYGRobHB0eHyAhIiMkJSYnKCkqKywtLi8wMTIzNDU2Nzg5Ojs8PT4/QA=="
      }
    ]
  }
}

confirmationrequired · object

The pending or completed passkey confirmation for these exact statement bytes.

Fields of confirmation

actionrequired · string

The protected action being confirmed.

agentoptional · string

The agent requesting this action, when applicable.

confirmed_atrequired · string or null (date-time)

When the person confirmed, in UTC; null while awaiting confirmation.

consentoptional · object

The question and choice the person is being asked to confirm.

Fields of consent

The agent reports these words. They are masked before being stored.

answerrequired · string

The answer the person is choosing.

questionrequired · string

The exact question presented to the person.

created_atrequired · string (date-time)

When it was asked. Read leniently, so a client still reads a server from before it.

declined_atoptional · string (date-time)

When its owner declined it. Declining ends it, so it expired then too.

detailsoptional · array of object

Separately labelled fields to read before confirming with a passkey.

Fields of details

Separately labelled fields to read before confirming with a passkey.

Each item has this shape.

labelrequired · string

Label of a fact shown during confirmation.

valuerequired · string

Value shown for that fact.

expires_atrequired · string (date-time)

When this credential or request expires, in UTC.

idrequired · string

Opaque confirmation identifier. Use its URL for the person's review.

itemoptional · string

Public name of the item the confirmation concerns.

personrequired · string

Handle of the person who must confirm.

reasonoptional · string

The reason for the proposed action.

repositoryoptional · string

The repository this action concerns, when applicable.

titlerequired · string

Short title for the person's confirmation page.

urlrequired · string

Absolute URL to open for the next step.

enveloperequired · null or object

The signed envelope after the owner's passkey confirms these exact bytes; null while pending.

Fields of envelope

One of these shapes

May be null.

A DSSE envelope, as the DSSE specification defines it.

payloadrequired · string

The statement's JSON, in standard base64.

payloadTyperequired · string

DSSE payload type: application/vnd.in-toto+json.

signaturesrequired · array of object

DSSE signatures over the pre-authentication encoding of this payload.

Fields of signatures

DSSE signatures over the pre-authentication encoding of this payload.

Each item has this shape.

keyidrequired · string

Identifier of the verification key. Pin it with the server and person you trust.

sigrequired · string

An Ed25519 signature over the envelope's PAE encoding, in base64.

RateLimit and RateLimit-Policy describe the request rate. Follow Retry-After when a response asks you to wait.

Problem responses

Errors use application/problem+json. Act on the stable code, and follow next when present. See the problem format.

check_key_scope403

A check-only key may call the test check, read its own usage and acceptance rule, contact support, and withdraw data sharing.

Use a person's sign-in for account management. More agent power needs the owner's passkey; this key cannot widen itself.

feature_off403

The namespace plan does not include this feature.

Retrying on the same plan will not help. GET /api/v1/namespaces/{namespace}/plan, and the namespace's Plan page in Settings, show what its plan includes.

unauthenticated401

The request carried no credentials.

Use this operation's sign-in method. Bearer credentials use Authorization: Bearer <token>; browser credentials use the session cookie.

invalid_token401

The token is unknown, expired, or revoked, its agent was revoked, or an OAuth token was used outside its MCP resource.

Stop using it. Sign in again, or ask the owner to create a replacement agent key.

forbidden403

The caller may not do this: only people may, only owners may, or the agent was not given this repository or write access.

Stop. Retrying will not help. Ask the owner for the access, or leave the step to a person.

already_exists409

Something with that name exists, or its current state does not allow this request.

Use the one that exists, or choose another name.

invalid_request400 / 413 / 415 / 422

The request is malformed or breaks a rule, such as a title that is too long, or a body that is not the expected JSON.

Fix the request as detail says. The same request fails the same way.

quota_exceeded422 / 429

With 429, the caller used its requests for the minute. With 422, a count limit was reached.

With 429, wait Retry-After seconds and retry. With 422, remove one first.

idempotency_key_reused409 / 422

The idempotency key was already used for a different request.

Use a new key for each new request, and the same key only for a retry of the same request.

idempotency_key_in_use409

The first request with this key is still running, including a queued model question, or it succeeded with a secret, such as a new token, which is never replayed.

When Retry-After is set, retry then with the same key. Otherwise the first request succeeded: do not repeat it.

internal500

The server failed, and logged why.

Retry after Retry-After seconds. A write is safe to retry with the same idempotency key.

unavailable503

With 502, a service the server needs did not answer, such as a sign-in provider. With 503, the server is busy, such as when a workspace is locked or host lookups are full, or a write with an idempotency key runs long: that write goes on, and its answer is kept for the key.

With 502, retry later, or sign in another way. With 503, retry after Retry-After seconds, using the same idempotency key for a write; a long-running write can then replay its answer.