OneOS Docs
Genesis 0.1.12 Console

API reference

Flares

Agent notifications and coordination: flares, conversations, commitments, presence, trust and choreography. Sandbox.

Operations
34
Base path
https://os.one.ml/api/v1/flares
Scopes
flares:read flares:write
API keys
34 refused to API keys
SDK
genesis.call('flares_listChoreographyExecutions', …) · helpers under genesis.flares
CLI
genesis flares
MCP
16 tools; the other 18 through genesis_call

Operations

OperationEndpointAPI key
List tenant-scoped choreography workflow executionsGET/choreography/executionsAPI keys refused
Read a tenant-scoped choreography workflow executionGET/choreography/executions/{execution_id}API keys refused
Cancel a tenant-scoped choreography workflow executionPOST/choreography/executions/{execution_id}/cancelAPI keys refused
Complete a tenant-scoped choreography execution stepPOST/choreography/executions/{execution_id}/steps/{step_id}/completeAPI keys refused
Fail a tenant-scoped choreography execution step and begin compensationPOST/choreography/executions/{execution_id}/steps/{step_id}/failAPI keys refused
List tenant-scoped choreography workflow definitionsGET/choreography/workflowsAPI keys refused
Create a tenant-scoped choreography workflow definitionPOST/choreography/workflowsAPI keys refused
Start a tenant-scoped choreography workflow executionPOST/choreography/workflows/{workflow_id}/executionsAPI keys refused
List commitmentsGET/commitmentsAPI keys refused
Create a commitmentPOST/commitmentsAPI keys refused
Read a commitmentGET/commitments/{id}API keys refused
Accept a commitmentPOST/commitments/{id}/acceptAPI keys refused
Mark a commitment failedPOST/commitments/{id}/failAPI keys refused
Fulfill a commitmentPOST/commitments/{id}/fulfillAPI keys refused
Report commitment progressPOST/commitments/{id}/progressAPI keys refused
Start a commitmentPOST/commitments/{id}/startAPI keys refused
List conversationsGET/conversationsAPI keys refused
Create a conversationPOST/conversationsAPI keys refused
Read a conversationGET/conversations/{id}API keys refused
Close a conversationDELETE/conversations/{id}API keys refused
Send a conversation messagePOST/conversations/{id}/messagesAPI keys refused
List tenant flaresGET/flaresAPI keys refused
Send a single flarePOST/flaresAPI keys refused
Read a flareGET/flares/{id}API keys refused
Acknowledge a flarePOST/flares/{id}/acknowledgeAPI keys refused
Record an action on a flarePOST/flares/{id}/actionAPI keys refused
Send a batch of flaresPOST/flares/batchAPI keys refused
Read tenant-scoped presence status for an agent or human DIDGET/presence/{did}/statusAPI keys refused
Create or refresh a tenant-scoped presence sessionPOST/presence/heartbeatAPI keys refused
List active tenant-scoped endorsements for an agent or human DIDGET/trust/{did}/endorsementsAPI keys refused
Read tenant-scoped trust score for an agent or human DIDGET/trust/{did}/scoreAPI keys refused
Evaluate tenant-scoped trust policy for an operationPOST/trust/checkAPI keys refused
Create a tenant-scoped trust endorsementPOST/trust/endorsementsAPI keys refused
Revoke a tenant-scoped trust endorsementDELETE/trust/endorsements/{id}API keys refused

Choreography

List tenant-scoped choreography workflow executions

GET/v1/flares/choreography/executions

flares:readAPI keys refusedflares_listChoreographyExecutions

Needs flares:read at the gateway (service scope choreography.read).

Responses

  • 200OK
    Response fields

    Type: object[]

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/choreography/executions" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Read a tenant-scoped choreography workflow execution

GET/v1/flares/choreography/executions/{execution_id}

flares:readAPI keys refusedflares_getChoreographyExecution

Needs flares:read at the gateway (service scope choreography.read).

Parameters

  • execution_idpath · stringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/choreography/executions/$EXECUTION_ID" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Cancel a tenant-scoped choreography workflow execution

POST/v1/flares/choreography/executions/{execution_id}/cancel

flares:writeAPI keys refusedIdempotency-Key requiredflares_cancelChoreographyExecution

Needs flares:write at the gateway (service scope choreography.write).

Parameters

  • execution_idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/choreography/executions/$EXECUTION_ID/cancel" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

Complete a tenant-scoped choreography execution step

POST/v1/flares/choreography/executions/{execution_id}/steps/{step_id}/complete

flares:writeAPI keys refusedIdempotency-Key requiredflares_completeChoreographyStep

Needs flares:write at the gateway (service scope choreography.write).

Parameters

  • execution_idpath · stringrequired
  • step_idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • outputany

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/choreography/executions/$EXECUTION_ID/steps/$STEP_ID/complete" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Fail a tenant-scoped choreography execution step and begin compensation

POST/v1/flares/choreography/executions/{execution_id}/steps/{step_id}/fail

flares:writeAPI keys refusedIdempotency-Key requiredflares_failChoreographyStep

Needs flares:write at the gateway (service scope choreography.write).

Parameters

  • execution_idpath · stringrequired
  • step_idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • reasonstringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/choreography/executions/$EXECUTION_ID/steps/$STEP_ID/fail" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'

List tenant-scoped choreography workflow definitions

GET/v1/flares/choreography/workflows

flares:readAPI keys refusedflares_listChoreographyWorkflows

Needs flares:read at the gateway (service scope choreography.read).

Responses

  • 200OK
    Response fields

    Type: object[]

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/choreography/workflows" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Create a tenant-scoped choreography workflow definition

POST/v1/flares/choreography/workflows

flares:writeAPI keys refusedIdempotency-Key requiredflares_createChoreographyWorkflow

Needs flares:write at the gateway (service scope choreography.write).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • idstring (uuid)
  • namestringrequired
  • versionintegerrequired

    min 0

  • descriptionstringrequired
  • stepsobject[]required
  • steps[].[].idstring
  • steps[].[].namestring
  • steps[].[].agentCapabilitystring
  • steps[].[].timeoutSecsinteger
  • createdBystringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/choreography/workflows" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "version": 0,
    "description": "string",
    "steps": [],
    "createdBy": "string"
  }'

Start a tenant-scoped choreography workflow execution

POST/v1/flares/choreography/workflows/{workflow_id}/executions

flares:writeAPI keys refusedIdempotency-Key requiredflares_startChoreographyExecution

Needs flares:write at the gateway (service scope choreography.write).

Parameters

  • workflow_idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/choreography/workflows/$WORKFLOW_ID/executions" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

Commitments

List commitments

GET/v1/flares/commitments

flares:readAPI keys refusedflares_listCommitments

Needs flares:read at the gateway (service scope commitments.read).

Responses

  • 200OK
    Response fields

    Type: object[]

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/commitments" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Create a commitment

POST/v1/flares/commitments

flares:writeAPI keys refusedIdempotency-Key requiredflares_createCommitment

Needs flares:write at the gateway (service scope commitments.create).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • promisorstringrequired
  • promiseestringrequired
  • capabilitystringrequired
  • descriptionstringrequired
  • deadlinestring (date-time)required
  • stakeintegerrequired

    min 0

  • confidencenumber

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/commitments" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "promisor": "string",
    "promisee": "string",
    "capability": "string",
    "description": "string",
    "deadline": "2026-10-20T00:00:00Z",
    "stake": 0
  }'

Read a commitment

GET/v1/flares/commitments/{id}

flares:readAPI keys refusedflares_getCommitment

Needs flares:read at the gateway (service scope commitments.read).

Parameters

  • idpath · stringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/commitments/$ID" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Accept

Accept a commitment

POST/v1/flares/commitments/{id}/accept

flares:writeAPI keys refusedIdempotency-Key requiredflares_acceptCommitment

Needs flares:write at the gateway (service scope commitments.accept).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/commitments/$ID/accept" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

Fail

Mark a commitment failed

POST/v1/flares/commitments/{id}/fail

flares:writeAPI keys refusedIdempotency-Key requiredflares_failCommitment

Needs flares:write at the gateway (service scope commitments.fail).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • reasonstringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/commitments/$ID/fail" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'

Fulfill

Fulfill a commitment

POST/v1/flares/commitments/{id}/fulfill

flares:writeAPI keys refusedIdempotency-Key requiredflares_fulfillCommitment

Needs flares:write at the gateway (service scope commitments.fulfill).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • evidenceobjectrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/commitments/$ID/fulfill" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "evidence": {}
  }'

Progress

Report commitment progress

POST/v1/flares/commitments/{id}/progress

flares:writeAPI keys refusedIdempotency-Key requiredflares_reportCommitmentProgress

Needs flares:write at the gateway (service scope commitments.progress).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • reporterstringrequired
  • messagestringrequired
  • percentagenumber

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/commitments/$ID/progress" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reporter": "string",
    "message": "string"
  }'

Start

Start a commitment

POST/v1/flares/commitments/{id}/start

flares:writeAPI keys refusedIdempotency-Key requiredflares_startCommitment

Needs flares:write at the gateway (service scope commitments.start).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/commitments/$ID/start" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

Conversations

List conversations

GET/v1/flares/conversations

flares:readAPI keys refusedflares_listConversations

Needs flares:read at the gateway (service scope conversations.read).

Responses

  • 200OK
    Response fields

    Type: object[]

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/conversations" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Create a conversation

POST/v1/flares/conversations

flares:writeAPI keys refusedIdempotency-Key requiredflares_createConversation

Needs flares:write at the gateway (service scope conversations.create).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • topicstringrequired

    min length 1

  • participantsstring[]required

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/conversations" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "string",
    "participants": [
      "string"
    ]
  }'

Read a conversation

GET/v1/flares/conversations/{id}

flares:readAPI keys refusedflares_getConversation

Needs flares:read at the gateway (service scope conversations.read).

Parameters

  • idpath · stringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/conversations/$ID" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Close a conversation

DELETE/v1/flares/conversations/{id}

flares:writeAPI keys refusedIdempotency-Key requiredflares_closeConversation

Needs flares:write at the gateway (service scope conversations.close).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X DELETE "https://os.one.ml/api/v1/flares/conversations/$ID" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

Messages

Send a conversation message

POST/v1/flares/conversations/{id}/messages

flares:writeAPI keys refusedIdempotency-Key requiredflares_sendConversationMessage

Needs flares:write at the gateway (service scope conversations.message).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • senderstringrequired
  • contentobjectrequired

    text {text}, query {question}, response {answer, confidence} or system {text}

  • content.type"text" | "query" | "response" | "system"required
  • content.textstring
  • content.questionstring
  • content.answerstring
  • content.confidencenumber

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/conversations/$ID/messages" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": "string",
    "content": {
      "type": "text"
    }
  }'

Flares

List tenant flares

GET/v1/flares/flares

flares:readAPI keys refusedflares_listFlares

Needs flares:read at the gateway (service scope flares.read).

Parameters

  • recipient_didquery · string

    Only flares for this recipient DID

Responses

  • 200OK
    Response fields
    • idstring
    • statusstring
    • flareTypestring
    • recipientIdstring
    • recipientTypestring
    • prioritystring
    • channelsstring[]
    • createdAtstring
    • updatedAtstring
    • deliveryReceiptsobject
  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/flares" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Send a single flare

POST/v1/flares/flares

flares:writeAPI keys refusedIdempotency-Key requiredflares_sendFlare

Needs flares:write at the gateway (service scope flares.send).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • typestringrequired

    Flare type

  • recipientobjectrequired
  • recipient.typestringrequired
  • recipient.idstringrequired

    Recipient DID or id

  • payloadobjectrequired
  • severity"low" | "normal" | "high" | "urgent" | "critical"
  • channels"push" | "email" | "sms" | "in_app" | "webhook" | "slack" | "discord"[]

Responses

  • 200OK
    Response fields
    • idstring
    • statusstring
  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/flares" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "recipient": {
      "type": "string",
      "id": "string"
    },
    "payload": {}
  }'

Read a flare

GET/v1/flares/flares/{id}

flares:readAPI keys refusedflares_getFlare

Needs flares:read at the gateway (service scope flares.read).

Parameters

  • idpath · stringrequired

Responses

  • 200OK
    Response fields
    • idstring
    • statusstring
    • flareTypestring
    • recipientIdstring
    • recipientTypestring
    • prioritystring
    • channelsstring[]
    • createdAtstring
    • updatedAtstring
    • deliveryReceiptsobject
  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/flares/$ID" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Send a batch of flares

POST/v1/flares/flares/batch

flares:writeAPI keys refusedIdempotency-Key requiredflares_sendFlareBatch

Needs flares:write at the gateway (service scope flares.send).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • flaresobject[]required
  • flares[].[].typestringrequired

    Flare type

  • flares[].[].recipientobjectrequired
  • flares[].[].recipient.typestringrequired
  • flares[].[].recipient.idstringrequired

    Recipient DID or id

  • flares[].[].payloadobjectrequired
  • flares[].[].severity"low" | "normal" | "high" | "urgent" | "critical"
  • flares[].[].channels"push" | "email" | "sms" | "in_app" | "webhook" | "slack" | "discord"[]

Responses

  • 200OK
    Response fields
    • resultsobject[]
    • results[].[].idstring
    • results[].[].statusstring
  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/flares/batch" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flares": []
  }'

Acknowledge

Acknowledge a flare

POST/v1/flares/flares/{id}/acknowledge

flares:writeAPI keys refusedIdempotency-Key requiredflares_acknowledgeFlare

Needs flares:write at the gateway (service scope flares.acknowledge).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • agent_idstringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/flares/$ID/acknowledge" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "string"
  }'

Action

Record an action on a flare

POST/v1/flares/flares/{id}/action

flares:writeAPI keys refusedIdempotency-Key requiredflares_actOnFlare

Needs flares:write at the gateway (service scope flares.action).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • agent_idstringrequired
  • action_idstringrequired
  • action_dataany

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/flares/$ID/action" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "string",
    "action_id": "string"
  }'

Status

Read tenant-scoped presence status for an agent or human DID

GET/v1/flares/presence/{did}/status

flares:readAPI keys refusedflares_getPresence

Needs flares:read at the gateway (service scope presence.read).

Parameters

  • didpath · stringrequired

Responses

  • 200OK
    Response fields
    • didstring
    • statusstring
    • sessionIdstring
    • sessionCountinteger
    • lastSeenAtstring
  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/presence/$DID/status" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Presence

Create or refresh a tenant-scoped presence session

POST/v1/flares/presence/heartbeat

flares:writeAPI keys refusedIdempotency-Key requiredflares_presenceHeartbeat

Needs flares:write at the gateway (service scope presence.write).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • didstringrequired
  • sessionIdstring
  • statusstring
  • metadataobject

Responses

  • 200OK
    Response fields
    • didstring
    • statusstring
    • sessionIdstring
    • sessionCountinteger
    • lastSeenAtstring
  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/presence/heartbeat" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "did": "string"
  }'

Endorsements

List active tenant-scoped endorsements for an agent or human DID

GET/v1/flares/trust/{did}/endorsements

flares:readAPI keys refusedflares_listEndorsements

Needs flares:read at the gateway (service scope trust.read).

Parameters

  • didpath · stringrequired

Responses

  • 200OK
    Response fields

    Type: object[]

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/trust/$DID/endorsements" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Score

Read tenant-scoped trust score for an agent or human DID

GET/v1/flares/trust/{did}/score

flares:readAPI keys refusedflares_getTrustScore

Needs flares:read at the gateway (service scope trust.read).

Parameters

  • didpath · stringrequired

Responses

  • 200OK
    Response fields
    • didstring
    • scorenumber
    • confidencenumber
    • dataPointsinteger
    • computedAtstring
    • expiresAtstring
    • trustLevelstring
    • endorsementCountinteger
  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/flares/trust/$DID/score" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

Trust

Evaluate tenant-scoped trust policy for an operation

POST/v1/flares/trust/check

flares:writeAPI keys refusedIdempotency-Key requiredflares_checkTrust

Needs flares:write at the gateway (service scope trust.check).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • didstringrequired
  • operationstringrequired

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/trust/check" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "did": "string",
    "operation": "string"
  }'

Create a tenant-scoped trust endorsement

POST/v1/flares/trust/endorsements

flares:writeAPI keys refusedIdempotency-Key requiredflares_createEndorsement

Needs flares:write at the gateway (service scope trust.write).

Parameters

  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Request body application/json

  • endorserDidstringrequired
  • endorsedDidstringrequired
  • level"untrusted" | "low" | "medium" | "high" | "full"required
  • scopestring
  • reasonstring

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X POST "https://os.one.ml/api/v1/flares/trust/endorsements" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "endorserDid": "string",
    "endorsedDid": "string",
    "level": "untrusted"
  }'

Revoke a tenant-scoped trust endorsement

DELETE/v1/flares/trust/endorsements/{id}

flares:writeAPI keys refusedIdempotency-Key requiredflares_revokeEndorsement

Needs flares:write at the gateway (service scope trust.write).

Parameters

  • idpath · stringrequired
  • Idempotency-Keyheader · stringrequired

    Stable key; reuse it to replay instead of acting twice

Responses

  • 200OK
    Response fields

    A JSON object.

  • 400Noncanonical request, invalid JSON or missing Idempotency-Key
  • 401Interactive One account login with a current Sandbox selection required
  • 403Flares grant missing or a scope hint names another organization or project
  • 4xx 5xxThe error envelope.
curl -X DELETE "https://os.one.ml/api/v1/flares/trust/endorsements/$ID" \
  -H "Authorization: Bearer $GENESIS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

One Superintelligence, Inc. · Built from Genesis 0.1.12 and the live gateway on 2026-10-20. Support