Agent_onboarding | Orishare docs

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/agent/signup_challenges" \  -H "Content-Type: application/json" \  -d '{}'

{  "challenge": "string",  "algorithm": "sha256-leading-zero-bits",  "difficulty": -9007199254740991,  "expires_at": "string"}

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

project_name*string

Shown to the person who claims the project.

Length1 <= length <= 120

timezone?string

Length1 <= length <= 64

Default"UTC"

allowed_origins?array<>

Exact browser origins of the app (https://app.example). Applied to both environments; change them later with PATCH /v1/client_configuration.

Itemsitems <= 20

owner_email?string

When set, only this verified email address can claim the project.

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 254

agent?

proof*

Response Body

`application/json`

curl -X POST "https://example.com/agent/signups" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "project_name": "Space Miner",    "allowed_origins": [      "https://spaceminer.example"    ],    "proof": {      "challenge": "sgc_00000000000000000000000000000001.c2FsdHNhbHRzYWx0c2FsdHNhbHQ",      "nonce": "48213"    }  }'

{  "organization": {    "id": "string",    "name": "string",    "slug": "string",    "claimed": true  },  "project": {    "id": "string",    "name": "string"  },  "environments": [    {      "id": "string",      "name": "string",      "runtime_class": "string",      "active": true,      "autonomy_mode": "auto",      "allowed_origins": [        "string"      ],      "secret_key": {        "id": "string",        "token": "string",        "scopes": [          "string"        ]      },      "publishable_key": {        "id": "string",        "token": "string"      }    }  ],  "agent": {    "user_id": "string",    "token_id": "string",    "token": "string",    "scopes": [      "string"    ]  },  "claim": {    "code": "string",    "url": "string",    "owner_email": "string"  },  "limits": {    "production_events_per_month": -9007199254740991,    "live_requires_claim": true,    "orishare_sent_messages": -9007199254740991  },  "links": {    "docs": "string",    "openapi": "string",    "dashboard": "string",    "mcp": "string"  }}

Replace the claim link of an unclaimed project (agent token only)

Authorization

personalAccessToken

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/agent/claim_codes" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

{  "organization_id": "string",  "code": "string",  "url": "string"}

What a claim link claims, for the claim page (public)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code*string

Length8 <= length <= 200

Response Body

`application/json`

curl -X POST "https://example.com/project_claim_previews" \  -H "Content-Type: application/json" \  -d '{    "code": "occ_example"  }'

{  "organization": {    "name": "string"  },  "created_at": "string",  "claimable": true,  "restricted_to_email": true}

Claim a project an agent created: the signed-in person with a verified email becomes its owner

Authorization

session

__Secure-orishare.session_token<token>

Browser session; local and staging use their configured runtime cookie prefix.

In: cookie

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code*string

Length8 <= length <= 200

Response Body

`application/json`

curl -X POST "https://example.com/project_claims" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "code": "occ_example"  }'

{  "organization": {    "id": "string",    "name": "string",    "slug": "string"  },  "role": "owner"}

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

501application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

501application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`