Download OpenAPI specification:
HUMAN platform API
| limit | integer <= 100 Default: 20 |
| cursor | string |
{- "data": [
- {
- "org_did": "did:org:acme",
- "name": "Acme Corp",
- "deployment_mode": "cloud",
- "autonomy_profile": "paranoid",
- "data_residency_tier": "local_only",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "has_more": true,
- "next_cursor": "string"
}| org_did required | string |
| name required | string |
| slug | string |
| deployment_mode | string Default: "cloud" Enum: "cloud" "self_hosted" "hybrid" |
| autonomy_profile | string Default: "balanced" Enum: "paranoid" "balanced" "aggressive" |
| data_residency_tier | string Default: "global" Enum: "local_only" "regional" "global" |
{- "org_did": "did:org:acme",
- "name": "Acme Corp",
- "deployment_mode": "cloud",
- "autonomy_profile": "balanced",
- "data_residency_tier": "global"
}{- "org_did": "did:org:acme",
- "name": "Acme Corp",
- "deployment_mode": "cloud",
- "autonomy_profile": "paranoid",
- "data_residency_tier": "local_only",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}| assetType | string Enum: "connector" "agent" "workflow" "capability" "workforce" "dataset" "muscle" |
| trustTier | string Enum: "community" "verified" "certified" "enterprise" |
| limit | integer Default: 20 |
| cursor | string |
{- "data": [
- {
- "id": "string",
- "name": "string",
- "version": "1.0.0",
- "asset_type": "connector",
- "publisher_id": "string",
- "review_status": "pending",
- "trust_tier": "community",
- "lifecycle_stage": "dev",
- "install_count": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
], - "has_more": true,
- "next_cursor": "string"
}Triggers the Marketplace Intake Agent automated review pipeline. Canon: FR-6.3
| name required | string |
| asset_type required | string Enum: "connector" "agent" "workflow" "capability" "workforce" "dataset" "muscle" |
| visibility | string Default: "org_private" Enum: "org_private" "org_internal" "global" |
| lifecycle_stage | string Default: "production" Enum: "dev" "staging" "production" |
object Canonical asset manifest (FR-9) |
{- "name": "string",
- "asset_type": "connector",
- "visibility": "org_private",
- "lifecycle_stage": "dev",
- "manifest": {
- "name": "string",
- "version": "string",
- "description": "string",
- "provenance": {
- "source": "string",
- "publishedBy": "string"
}, - "capabilities": {
- "required_scopes": [
- "string"
]
}
}
}{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}| orgDid required | string |
{- "orgDid": "string"
}{- "bucket": "healthy",
- "checks": [
- {
- "name": "string",
- "status": "string"
}
], - "escalation_id": "string"
}Human-in-the-loop escalation queue: list and respond to approval requests
| orgDid | string |
| status | string Default: "pending" |
| limit | integer Default: 20 |
{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}| id required | string |
| decision required | string Enum: "approve" "approved_with_modifications" "reject" "request_changes" |
| notes | string |
| modifications | string |
{- "decision": "approve",
- "notes": "string",
- "modifications": "string"
}{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}Requires cloud:admin:global scope and DEPLOYMENT_MODE=cloud.
{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}In the ever-evolving symphony of Human-AI orchestration, keeping an eye on the platform's health is akin to tuning an instrument. This endpoint provides a pulse check, ensuring that all systems are harmonized and ready to perform their roles in the grand concert of tasks and identity management.
nullnullIn the ever-evolving symphony of Human-AI orchestration, keeping an eye on the platform's health is akin to tuning an instrument. This endpoint provides a pulse check, ensuring that all systems are harmonized and ready to perform their roles in the grand concert of tasks and identity management.
nullnullIn the digital realm, identities are as crucial as they are in the physical world. This endpoint serves as a gateway to retrieve the Decentralized Identifier (DID) document, a critical piece for establishing cryptographic identity within the HUMAN platform. By accessing this, organizations like 'Acme Corp' can verify entity identities and ensure secure interactions in their decentralized applications.
null{- "id": "did:example:123456789abcdefghi",
- "publicKey": [
- {
- "id": "did:example:123456789abcdefghi#keys-1",
- "type": "RsaVerificationKey2018",
- "controller": "did:example:123456789abcdefghi",
- "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----"
}
], - "authentication": [
- {
- "type": "RsaSignatureAuthentication2018",
- "publicKey": "did:example:123456789abcdefghi#keys-1"
}
]
}Embark on a journey to secure digital identities with device-rooted human passports. This endpoint lays the groundwork for passkey registration, ensuring every user begins with the right cryptographic identity. It is the first step in a seamless WebAuthn integration, bringing together the human touch and cryptographic security.
| userId required | string Unique identifier for the user requesting registration options. |
A typical request initiated by a user to start the registration process.
{- "userId": "user-12345"
}nullIn the realm of digital identities, the Passport is your cryptographic beacon. This endpoint allows you to register your device-rooted Passport with the HUMAN Protocol, ensuring your identity can be discovered and verified across the ecosystem. By validating the self-signed proof from your Passport, it sets the stage for seamless interactions in the HUMAN network.
| proof required | string Self-signed cryptographic proof from the Passport |
| deviceId required | string Unique identifier of the device where the Passport is created |
| publicKey required | string Public key associated with the Passport for identity verification |
Register a Passport for a device with its cryptographic proof
{- "proof": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "deviceId": "device-12345",
- "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ..."
}nullImagine a world where human and AI collaboration is seamless. The Passport endpoint is your gateway into this world, providing the cryptographic identity essential for secure and efficient collaboration. By retrieving a Passport, you gain access to the capabilities and provenance of a specific agent within the HUMAN ecosystem.
null{- "id": "passport-12345",
- "owner": "did:human:acme-john-doe",
- "capabilities": [
- "capability://invoice.processing",
- "capability://task.routing"
], - "createdAt": "2023-09-15T14:00:00Z"
}This endpoint provides the JSON Web Key Set (JWKS) for a specific Passport, enabling secure cryptographic verification of identity assertions. By accessing these keys, clients can validate the digital signatures of tokens issued by the HUMAN platform, ensuring the authenticity and integrity of interactions within the network.
nullAn example response showing a typical JWKS with one public key.
{- "keys": [
- {
- "kty": "RSA",
- "use": "sig",
- "kid": "12345",
- "alg": "RS256",
- "n": "0vx7...b7Q",
- "e": "AQAB"
}
]
}In the ever-evolving digital landscape, security is paramount. This endpoint allows for the rotation of cryptographic keys associated with a Passport, ensuring continued trust and integrity. By refreshing these keys, organizations can enhance their security posture against potential threats.
| passphrase required | string A secret passphrase for additional security during key rotation. |
Rotating keys using a secure passphrase.
{- "passphrase": "correcthorsebatterystaple"
}nullIn the world of HUMAN Protocol, safeguarding identities is paramount. This endpoint allows trusted human guardians to be enrolled for recovery, ensuring that if access to a cryptographic Passport is lost, it can be retrieved securely. By enrolling a recovery policy, users weave a safety net against potential identity mishaps.
| guardianId required | string The unique identifier (DID) of the guardian. |
| recoveryMethod required | string The method by which recovery will be conducted, e.g., 'email' or 'sms'. |
Shows how to enroll Alice as a recovery guardian using email.
{- "guardianId": "did:example:alice",
- "recoveryMethod": "email"
}nullIn the intricate dance between humans and AI, identity is sacred. This endpoint allows the creation of a recovery request for a lost Passport, ensuring continuity and trust in a user's cryptographic identity. It acts as a lifeline, allowing organizations like 'Acme Corp' to regain access when their connection to the HUMAN network falters.
| recoveryContact required | string Email or phone number for contacting the user |
| reason required | string Reason for recovery request |
Initiating a recovery for a Passport with a lost private key
{- "recoveryContact": "user@acme.org",
- "reason": "Lost private key for Passport recovery"
}nullIn the intricate dance of human and AI collaboration, knowing who agreed to what is crucial. This endpoint records consent events, weaving a tapestry of trust by tracking provenance and optionally registering capabilities granted through consent.
| consentTimestamp required | string <date-time> The timestamp when consent was given. |
| capabilityEvidence | string Optional evidence of capability if consent grants a new capability. |
| description required | string A brief description of the consent event. |
Records a consent event with a timestamp and description.
{- "consentTimestamp": "2023-10-15T13:45:30Z",
- "description": "Consent to process payroll data for Acme Corp."
}nullIn the world of HUMAN, trust is the currency. This endpoint verifies capability proofs, ensuring that agents possess the skills they claim. By validating these cryptographic tokens, HUMAN fosters a reliable ecosystem where tasks are routed to the most capable agents, preserving the integrity of your operations.
| agentDid required | string Decentralized Identifier of the agent |
| capabilityProof required | string Cryptographic proof of capability |
| taskId required | string Identifier of the task that requires verification |
This example demonstrates verifying an agent's capability to process invoices for the 'acme' organization.
{- "agentDid": "did:human:123456789abcdefghi",
- "capabilityProof": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "taskId": "task-987654321"
}nullEmpower your HUMAN Passport by generating a delegation token, allowing trusted entities limited access to your capabilities. This endpoint ensures that only the right skills are leveraged in collaborative tasks, preserving both security and efficiency in orchestrated human-AI workflows.
| agentId required | string The unique identifier of the agent requesting the delegation. |
| capabilities required | Array of strings |
Delegating invoice processing capability to an agent.
{- "agentId": "did:human:12345",
- "capabilities": [
- "capability://acme/invoice.process"
]
}nullIn a world where trust is paramount, accessing delegation tokens empowers systems to verify and manage capabilities across the HUMAN network. Imagine a scenario where 'Acme Corp' needs to orchestrate tasks seamlessly between human and AI agents, ensuring safety and provenance at every step.
nullnullIn the HUMAN ecosystem, linking your Passport to an organization is pivotal. This endpoint empowers users to verify their email using a 6-digit code, completing the Passport-to-org linkage and triggering a trust attestation. It's where your digital identity begins to truly resonate with the HUMAN network.
| verificationCode required | string^[0-9]{6}$ 6-digit code sent to the user's email. |
A user verifies their email with a correct code.
{- "verificationCode": "123456"
}{- "message": "Email verified successfully, Passport linked to organization."
}Unveil the tapestry of trust by fetching all attestations linked to a specific Passport. This endpoint empowers organizations to trace the provenance of capabilities, ensuring transparency and accountability within the HUMAN ecosystem.
[- {
- "attestationId": "att123",
- "skill": "AI Engineering",
- "issuer": "did:human:acme123",
- "timestamp": "2023-10-01T12:34:56Z"
}, - {
- "attestationId": "att456",
- "skill": "Data Analysis",
- "issuer": "did:human:acme123",
- "timestamp": "2023-09-15T09:21:30Z"
}
]In the sprawling network of human and AI collaboration, connectors are the bridges enabling seamless communication. This endpoint allows you to retrieve detailed information about a specific connector using its unique identifier, ensuring transparency and trust in the HUMAN ecosystem.
nullnullDiscover the capabilities and identity of a specific agent within the HUMAN ecosystem. This endpoint allows you to access detailed information about an agent, tracked through the HUMAN Passport and Capability Graph, to understand its roles and functions. Uncover how agents are orchestrated to perform tasks safely and transparently.
nullnullIn the digital realm, identities are as crucial as they are in the physical world. This endpoint serves as a gateway to retrieve the Decentralized Identifier (DID) document, a critical piece for establishing cryptographic identity within the HUMAN platform. By accessing this, organizations like 'Acme Corp' can verify entity identities and ensure secure interactions in their decentralized applications.
null{- "id": "did:example:123456789abcdefghi",
- "publicKey": [
- {
- "id": "did:example:123456789abcdefghi#keys-1",
- "type": "RsaVerificationKey2018",
- "controller": "did:example:123456789abcdefghi",
- "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----"
}
], - "authentication": [
- {
- "type": "RsaSignatureAuthentication2018",
- "publicKey": "did:example:123456789abcdefghi#keys-1"
}
]
}Embark on a journey to secure digital identities with device-rooted human passports. This endpoint lays the groundwork for passkey registration, ensuring every user begins with the right cryptographic identity. It is the first step in a seamless WebAuthn integration, bringing together the human touch and cryptographic security.
| userId required | string Unique identifier for the user requesting registration options. |
A typical request initiated by a user to start the registration process.
{- "userId": "user-12345"
}nullIn the world of digital identity, security is paramount. This endpoint offers a secure pathway to initiate the rotation of WebAuthn credentials for a given Passport. By doing so, it enhances the cryptographic integrity and future-proofs the identity against potential vulnerabilities.
| challenge required | string A unique challenge provided by the client to ensure the request's authenticity. |
An example request to initiate the WebAuthn credential rotation with a challenge.
{- "challenge": "Y2hhbGxlbmdlX3Rva2Vu"
}nullIn the realm of digital identities, the Passport is your cryptographic beacon. This endpoint allows you to register your device-rooted Passport with the HUMAN Protocol, ensuring your identity can be discovered and verified across the ecosystem. By validating the self-signed proof from your Passport, it sets the stage for seamless interactions in the HUMAN network.
| proof required | string Self-signed cryptographic proof from the Passport |
| deviceId required | string Unique identifier of the device where the Passport is created |
| publicKey required | string Public key associated with the Passport for identity verification |
Register a Passport for a device with its cryptographic proof
{- "proof": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "deviceId": "device-12345",
- "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ..."
}nullThis endpoint provides the JSON Web Key Set (JWKS) for a specific Passport, enabling secure cryptographic verification of identity assertions. By accessing these keys, clients can validate the digital signatures of tokens issued by the HUMAN platform, ensuring the authenticity and integrity of interactions within the network.
nullAn example response showing a typical JWKS with one public key.
{- "keys": [
- {
- "kty": "RSA",
- "use": "sig",
- "kid": "12345",
- "alg": "RS256",
- "n": "0vx7...b7Q",
- "e": "AQAB"
}
]
}In the ever-evolving digital landscape, security is paramount. This endpoint allows for the rotation of cryptographic keys associated with a Passport, ensuring continued trust and integrity. By refreshing these keys, organizations can enhance their security posture against potential threats.
| passphrase required | string A secret passphrase for additional security during key rotation. |
Rotating keys using a secure passphrase.
{- "passphrase": "correcthorsebatterystaple"
}nullIn the HUMAN platform, security is paramount. This endpoint allows for the swift revocation of a cryptographic key associated with a Passport, ensuring that compromised credentials can no longer be used. By leveraging this API, organizations can maintain the integrity of their identity management system and protect sensitive operations.
| reason required | string Explanation of why the key is being revoked. |
Revoke a key due to routine security audits identifying potential vulnerabilities.
{- "reason": "Routine security audit revealed potential exposure."
}nullIn the world of HUMAN Protocol, safeguarding identities is paramount. This endpoint allows trusted human guardians to be enrolled for recovery, ensuring that if access to a cryptographic Passport is lost, it can be retrieved securely. By enrolling a recovery policy, users weave a safety net against potential identity mishaps.
| guardianId required | string The unique identifier (DID) of the guardian. |
| recoveryMethod required | string The method by which recovery will be conducted, e.g., 'email' or 'sms'. |
Shows how to enroll Alice as a recovery guardian using email.
{- "guardianId": "did:example:alice",
- "recoveryMethod": "email"
}nullIn the intricate dance between humans and AI, identity is sacred. This endpoint allows the creation of a recovery request for a lost Passport, ensuring continuity and trust in a user's cryptographic identity. It acts as a lifeline, allowing organizations like 'Acme Corp' to regain access when their connection to the HUMAN network falters.
| recoveryContact required | string Email or phone number for contacting the user |
| reason required | string Reason for recovery request |
Initiating a recovery for a Passport with a lost private key
{- "recoveryContact": "user@acme.org",
- "reason": "Lost private key for Passport recovery"
}nullWhen a user's cryptographic identity is compromised, this endpoint empowers guardians or trusted delegates to approve a recovery request. It's not just about restoring access; it's about safeguarding the integrity of one's digital journey in the HUMAN ecosystem.
| approvedBy required | string DID of the guardian or delegating entity approving the request |
| timestamp required | string <date-time> ISO 8601 timestamp of when the approval was made |
A guardian with DID 'did:human:guardian123' approves a recovery request at the current timestamp.
{- "approvedBy": "did:human:guardian123",
- "timestamp": "2023-10-12T08:42:45Z"
}nullIn the complex ballet of digital identity, recovery requests are the safety nets. This endpoint executes an approved recovery request for a passport, ensuring that when digital identities need resurrection, they rise flawlessly. It exists to bring peace of mind in the orchestration of human and AI capabilities.
| confirmationCode required | string The confirmation code sent for recovery verification. |
Executing a recovery request with a valid confirmation code.
{- "confirmationCode": "123456"
}nullIn the bustling digital landscape, proving one's capabilities is more than just an assurance—it's a necessity. This endpoint allows you to submit cryptographic proofs that validate an agent's skills, ensuring trust and integrity within the HUMAN network. It's the backbone of verifiable digital identities and skills, fostering a reliable ecosystem for all participants.
| agentId required | string The unique identifier of the agent. |
| skillId required | string The identifier of the skill being proven. |
| proofDocument required | string A cryptographic document that serves as proof of the agent's skills. |
Submitting a proof for an agent with a specific skill.
{- "agentId": "agent12345",
- "skillId": "capability://acme/skill/invoice-processing",
- "proofDocument": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}nullEmpower your HUMAN Passport by generating a delegation token, allowing trusted entities limited access to your capabilities. This endpoint ensures that only the right skills are leveraged in collaborative tasks, preserving both security and efficiency in orchestrated human-AI workflows.
| agentId required | string The unique identifier of the agent requesting the delegation. |
| capabilities required | Array of strings |
Delegating invoice processing capability to an agent.
{- "agentId": "did:human:12345",
- "capabilities": [
- "capability://acme/invoice.process"
]
}nullIn the HUMAN ecosystem, delegation tokens are the keys to accessing a symphony of capabilities. This endpoint allows you to revoke such a key, ensuring that expired or compromised access is swiftly curtailed. Use this to maintain the integrity and security of your HUMAN orchestrations.
nullnullIn a world where trust is paramount, rotating your delegation token ensures the integrity and security of your AI orchestration tasks. This endpoint empowers organizations to seamlessly update their tokens, safeguarding their operations from unauthorized access.
| reason required | string The reason for rotating the token, which helps in auditing and understanding token lifecycle events. |
An organization decides to rotate their token after a security policy update.
{- "reason": "Security policy update"
}nullIn the intricate dance of human and AI collaboration, ensuring the integrity of task delegations is paramount. This endpoint allows you to verify if a specific delegation has been revoked, safeguarding against unauthorized actions and maintaining trust within the network.
nullnullIn the intricate dance of human and AI orchestration, sometimes a delegate's role must be rescinded. This endpoint enables the termination of a specific delegation, ensuring that control is returned to the rightful originator. It's a crucial mechanism for safeguarding the integrity of tasks and capabilities within the HUMAN Protocol's Capability Graph.
| reason required | string The rationale for revoking the delegation, aiding in audit trails. |
Demonstrates revoking a delegation due to a suspected security breach.
{- "reason": "Suspicion of unauthorized access to sensitive data."
}nullIn a world where digital identities are paramount, recovering access to your cryptographic identity is vital. This endpoint facilitates the initiation of WebAuthn recovery options for a user's Passport, ensuring secure and seamless retrieval of access in case of lost credentials.
| initiator required | string DID of the entity initiating the recovery. |
Request to start WebAuthn recovery for a Passport owned by 'acme'.
{- "initiator": "did:example:123456789abcdefghi"
}nullIn a world where digital identities are paramount, recovering access to your cryptographic identity is vital. This endpoint facilitates the initiation of WebAuthn recovery options for a user's Passport, ensuring secure and seamless retrieval of access in case of lost credentials.
| initiator required | string DID of the entity initiating the recovery. |
Request to start WebAuthn recovery for a Passport owned by 'acme'.
{- "initiator": "did:example:123456789abcdefghi"
}nullIn the world of digital identity, security is paramount. This endpoint offers a secure pathway to initiate the rotation of WebAuthn credentials for a given Passport. By doing so, it enhances the cryptographic integrity and future-proofs the identity against potential vulnerabilities.
| challenge required | string A unique challenge provided by the client to ensure the request's authenticity. |
An example request to initiate the WebAuthn credential rotation with a challenge.
{- "challenge": "Y2hhbGxlbmdlX3Rva2Vu"
}nullUnveil a passport's history by retrieving its consent log, where every agreement and permission granted is meticulously recorded. This endpoint empowers organizations to monitor and ensure compliance with privacy policies, safeguarding both user trust and regulatory adherence.
nullnullThis endpoint serves as a bridge between an individual's cryptographic identity (Passport) and their organizational persona. By linking these identities, it streamlines the process of task allocation and skill tracking within the HUMAN network, ensuring that individuals can seamlessly transition between roles and responsibilities.
| linkingCode required | string A secure code provided for linking the Passport to the organization. |
| email required | string <email> Email address for sending the verification code. |
Demonstrates linking a Passport to an employee record at Acme Corporation.
{- "linkingCode": "abc123def456",
- "email": "john.doe@acme.com"
}nullImagine a world where human and AI collaboration is seamless. The Passport endpoint is your gateway into this world, providing the cryptographic identity essential for secure and efficient collaboration. By retrieving a Passport, you gain access to the capabilities and provenance of a specific agent within the HUMAN ecosystem.
null{- "id": "passport-12345",
- "owner": "did:human:acme-john-doe",
- "capabilities": [
- "capability://invoice.processing",
- "capability://task.routing"
], - "createdAt": "2023-09-15T14:00:00Z"
}In the dynamic world of HUMAN, delegating passport permissions is akin to entrusting a reliable ally with your keys. This endpoint empowers you to extend specific capabilities from one identity to another, ensuring tasks are executed with precision and trust. It's not just about sharing access; it's about enhancing collaboration in a network of trusted entities.
| delegateeDID required | string Decentralized Identifier (DID) of the delegatee. |
| capabilities required | Array of strings |
Delegating invoice processing capabilities to a trusted entity within the 'acme' organization.
{- "delegateeDID": "did:human:acme123",
- "capabilities": [
- "capability://invoice.processing",
- "capability://payment.record"
]
}nullIn the HUMAN platform, security is paramount. This endpoint allows for the swift revocation of a cryptographic key associated with a Passport, ensuring that compromised credentials can no longer be used. By leveraging this API, organizations can maintain the integrity of their identity management system and protect sensitive operations.
| reason required | string Explanation of why the key is being revoked. |
Revoke a key due to routine security audits identifying potential vulnerabilities.
{- "reason": "Routine security audit revealed potential exposure."
}nullWhen a user's cryptographic identity is compromised, this endpoint empowers guardians or trusted delegates to approve a recovery request. It's not just about restoring access; it's about safeguarding the integrity of one's digital journey in the HUMAN ecosystem.
| approvedBy required | string DID of the guardian or delegating entity approving the request |
| timestamp required | string <date-time> ISO 8601 timestamp of when the approval was made |
A guardian with DID 'did:human:guardian123' approves a recovery request at the current timestamp.
{- "approvedBy": "did:human:guardian123",
- "timestamp": "2023-10-12T08:42:45Z"
}nullIn the complex ballet of digital identity, recovery requests are the safety nets. This endpoint executes an approved recovery request for a passport, ensuring that when digital identities need resurrection, they rise flawlessly. It exists to bring peace of mind in the orchestration of human and AI capabilities.
| confirmationCode required | string The confirmation code sent for recovery verification. |
Executing a recovery request with a valid confirmation code.
{- "confirmationCode": "123456"
}nullIn the HUMAN ecosystem, delegation tokens are the keys to accessing a symphony of capabilities. This endpoint allows you to revoke such a key, ensuring that expired or compromised access is swiftly curtailed. Use this to maintain the integrity and security of your HUMAN orchestrations.
nullnullIn a world where trust is paramount, rotating your delegation token ensures the integrity and security of your AI orchestration tasks. This endpoint empowers organizations to seamlessly update their tokens, safeguarding their operations from unauthorized access.
| reason required | string The reason for rotating the token, which helps in auditing and understanding token lifecycle events. |
An organization decides to rotate their token after a security policy update.
{- "reason": "Security policy update"
}nullIn the dynamic world of HUMAN, delegating passport permissions is akin to entrusting a reliable ally with your keys. This endpoint empowers you to extend specific capabilities from one identity to another, ensuring tasks are executed with precision and trust. It's not just about sharing access; it's about enhancing collaboration in a network of trusted entities.
| delegateeDID required | string Decentralized Identifier (DID) of the delegatee. |
| capabilities required | Array of strings |
Delegating invoice processing capabilities to a trusted entity within the 'acme' organization.
{- "delegateeDID": "did:human:acme123",
- "capabilities": [
- "capability://invoice.processing",
- "capability://payment.record"
]
}nullIn a world where trust is paramount, accessing delegation tokens empowers systems to verify and manage capabilities across the HUMAN network. Imagine a scenario where 'Acme Corp' needs to orchestrate tasks seamlessly between human and AI agents, ensuring safety and provenance at every step.
nullnullIn the vast network of human-AI collaboration, delegation tokens play a pivotal role. This endpoint allows you to retrieve detailed information about a specific delegation token using its unique identifier. Understanding the provenance and capabilities tied to these tokens is crucial for ensuring secure and efficient task orchestration in the HUMAN ecosystem.
nullnullIn a world where trust is paramount, the /v1/delegation-tokens/by-delegation/:id endpoint serves as a digital detective. It meticulously sifts through the cryptographic archives of HUMAN to fetch delegation tokens associated with a specific ID, ensuring that every transaction and delegation is accounted for with precision and clarity.
nullnullIn the intricate dance of human and AI collaboration, ensuring the integrity of task delegations is paramount. This endpoint allows you to verify if a specific delegation has been revoked, safeguarding against unauthorized actions and maintaining trust within the network.
nullnullIn the intricate dance of human and AI collaboration, knowing who agreed to what is crucial. This endpoint records consent events, weaving a tapestry of trust by tracking provenance and optionally registering capabilities granted through consent.
| consentTimestamp required | string <date-time> The timestamp when consent was given. |
| capabilityEvidence | string Optional evidence of capability if consent grants a new capability. |
| description required | string A brief description of the consent event. |
Records a consent event with a timestamp and description.
{- "consentTimestamp": "2023-10-15T13:45:30Z",
- "description": "Consent to process payroll data for Acme Corp."
}nullUnveil a passport's history by retrieving its consent log, where every agreement and permission granted is meticulously recorded. This endpoint empowers organizations to monitor and ensure compliance with privacy policies, safeguarding both user trust and regulatory adherence.
nullnullIn the intricate dance of human and AI collaboration, knowing who agreed to what is crucial. This endpoint records consent events, weaving a tapestry of trust by tracking provenance and optionally registering capabilities granted through consent.
| consentTimestamp required | string <date-time> The timestamp when consent was given. |
| capabilityEvidence | string Optional evidence of capability if consent grants a new capability. |
| description required | string A brief description of the consent event. |
Records a consent event with a timestamp and description.
{- "consentTimestamp": "2023-10-15T13:45:30Z",
- "description": "Consent to process payroll data for Acme Corp."
}nullUnravel the journey of a workflow through the HUMAN platform with this endpoint. Dive deep into the provenance of your tasks to understand how they were orchestrated by HumanOS. This traceability ensures transparency, accountability, and integrity within your operations.
The /v1/events endpoint opens a gateway to the dynamic world of provenance tracking within the HUMAN ecosystem. As humans and AI collaborate, every action leaves a breadcrumb trail of events. This endpoint allows you to retrieve these events, providing transparency and trust in the orchestration process. Dive into the flow of activities and discover the narrative behind every task completion and modification.
nullnullDive into the depths of data origins with our provenance query endpoint. This tool empowers organizations like 'Acme Corp' to trace the lineage of their data, ensuring transparency and trust in every byte processed. By connecting the dots of past transactions, you gain unparalleled insight into your data's journey.
| query required | string The query string used to search the provenance records. |
object | |
| limit | integer The maximum number of records to return. |
An example showing a simple provenance query with a filter.
{- "query": "SELECT * FROM provenance WHERE agent='acme'",
- "filters": {
- "dateRange": "2023-01-01 to 2023-12-31"
}, - "limit": 100
}nullIn a world where trust is paramount, this endpoint allows organizations to cryptographically attest to the integrity of their data provenance records. By doing so, it ensures that every transaction and interaction involving human and AI agents is securely recorded, maintaining accountability throughout the process.
| agentId required | string The unique identifier of the agent making the attestation. |
| organizationId required | string The unique identifier of the organization responsible for the provenance record. |
| recordHash required | string The cryptographic hash of the data being attested. |
| timestamp required | string <date-time> The ISO 8601 timestamp when the attestation is made. |
An example of an organization attesting to the integrity of an invoice processing record.
{- "agentId": "agent123",
- "organizationId": "org-acme",
- "recordHash": "abc123def456ghi789",
- "timestamp": "2023-10-01T12:00:00Z"
}nullUncover a treasure trove of capabilities that the HUMAN platform orchestrates across its vast network. This endpoint provides a comprehensive view of the skills and functionalities currently available, helping organizations like 'acme' to strategically align their human-AI efforts. It's not just about knowing what's possible—it's about unlocking potential.
This example demonstrates a typical request to the endpoint, which does not require any parameters.
{ }nullUncover a treasure trove of capabilities that the HUMAN platform orchestrates across its vast network. This endpoint provides a comprehensive view of the skills and functionalities currently available, helping organizations like 'acme' to strategically align their human-AI efforts. It's not just about knowing what's possible—it's about unlocking potential.
This example demonstrates a typical request to the endpoint, which does not require any parameters.
{ }nullDiscover how HUMAN's orchestration protocol dynamically routes tasks by querying capabilities overlaid with organizational intelligence. This endpoint reveals the intricate dance between human skills and AI safety, ensuring every task finds its perfect match.
nullnullUncover the intricate web of skills and capabilities that a human agent possesses through their Passport. This endpoint allows organizations to map out and understand the dynamic capabilities of their team, enabling strategic task assignments and growth opportunities.
nullDive into the universe of skills with the HUMAN platform by exploring all available capability definitions. These definitions are the blueprint of what tasks can be orchestrated through HumanOS, offering a comprehensive view of the skills tracked within the Capability Graph. This endpoint empowers organizations to understand and harness the full potential of their human and AI resources.
nullAn example list of capability definitions, showcasing the diverse skill sets within an organization.
[- {
- "capabilityId": "capability://acme/invoice-processing",
- "name": "Invoice Processing",
- "description": "Automated handling and processing of invoices for efficiency and accuracy."
}, - {
- "capabilityId": "capability://acme/data-analysis",
- "name": "Data Analysis",
- "description": "Advanced data analysis for deriving actionable insights from complex datasets."
}
]In the intricate dance of Human-AI collaboration, defining capabilities is like setting the stage for a symphony. This endpoint allows you to introduce new skills into the Capability Graph, ensuring your AI agents are equipped to handle the evolving tasks of tomorrow. By defining capabilities, you enable precise skill tracking and efficient task routing across your organization.
| capabilityId required | string A unique identifier for the capability, following the format: capability:// |
| name required | string A human-readable name for the capability. |
| description required | string A detailed description of what the capability entails. |
| tags | Array of strings Tags to categorize the capability for easy search and retrieval. |
Shows how to define a new capability for processing invoices in 'acme' organization.
{- "capabilityId": "capability://acme/invoice-processing",
- "name": "Invoice Processing",
- "description": "Capability to process and validate invoices within the Acme Corporation.",
- "tags": [
- "finance",
- "invoice",
- "processing"
]
}nullIntegrate new capabilities into your HUMAN network with ease, ensuring that each skill is precisely tracked within your Capability Graph. This endpoint empowers organizations like 'acme' to seamlessly update their skill sets, fostering a dynamic and adaptable workforce in an ever-evolving landscape.
required | Array of objects |
This example demonstrates importing a set of new capabilities for an organization.
{- "capabilityDefinitions": [
- {
- "name": "Data Processing",
- "description": "Processes large datasets efficiently.",
- "version": "1.0",
- "skills": [
- "data-cleaning",
- "data-transformation"
]
}, - {
- "name": "AI Moderation",
- "description": "Moderates content using AI algorithms.",
- "version": "2.5",
- "skills": [
- "content-analysis",
- "sentiment-analysis"
]
}
]
}Shows a successful import response.
{- "status": "success",
- "importedCount": 2
}In the dynamic world of Human-AI collaboration, elevating a capability is akin to unlocking a new level in a game. This endpoint allows organizations to promote a capability definition, enabling it to be more broadly recognized and utilized within the HUMAN ecosystem. By doing so, you ensure that your capabilities remain at the forefront of technological advancement.
| reason required | string The justification for promoting this capability. |
This example shows how to promote a capability definition for AI data processing to enhance its visibility within the organization.
{- "reason": "Enhancing AI data processing to improve organizational efficiency."
}nullIn the bustling digital landscape, proving one's capabilities is more than just an assurance—it's a necessity. This endpoint allows you to submit cryptographic proofs that validate an agent's skills, ensuring trust and integrity within the HUMAN network. It's the backbone of verifiable digital identities and skills, fostering a reliable ecosystem for all participants.
| agentId required | string The unique identifier of the agent. |
| skillId required | string The identifier of the skill being proven. |
| proofDocument required | string A cryptographic document that serves as proof of the agent's skills. |
Submitting a proof for an agent with a specific skill.
{- "agentId": "agent12345",
- "skillId": "capability://acme/skill/invoice-processing",
- "proofDocument": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}nullDiscover how HUMAN's orchestration protocol dynamically routes tasks by querying capabilities overlaid with organizational intelligence. This endpoint reveals the intricate dance between human skills and AI safety, ensuring every task finds its perfect match.
nullnullIn the dynamic world of HUMAN, the Capability Resolution Engine (CRE) serves as the maestro, orchestrating a symphony of human and AI collaboration. This endpoint finds the perfect match of humans and agents possessing the required capabilities, ensuring every task is routed to the right hands or silicon minds. It's the beating heart of an ecosystem where skills and needs intersect seamlessly.
| requiredCapabilities required | Array of strings List of capability URIs that the task requires. |
object Additional context about the task to aid in capability matching. |
Requesting a match for capabilities required to process invoices.
{- "requiredCapabilities": [
- "capability://finance/invoice-processing",
- "capability://ai/ocr"
], - "taskContext": {
- "priority": "high",
- "dueDate": "2023-11-15T00:00:00Z"
}
}nullIn the bustling ecosystem of HUMAN, skill allocation is paramount. This endpoint empowers administrators to enhance their agents by granting them new capabilities, thus expanding their skillset within the Capability Graph. It's the bridge to a more knowledgeable future, ensuring that agents are always equipped to tackle the tasks of tomorrow.
| agentDID required | string Decentralized Identifier of the agent. |
| capabilities required | Array of strings |
Assigns the 'process invoices' capability to an agent within the 'acme' organization.
{- "agentDID": "did:example:123456789abcdefghi",
- "capabilities": [
- "capability://finance/invoice-processing"
]
}nullIn the dynamic world of HUMAN, the Capability Resolution Engine (CRE) serves as the maestro, orchestrating a symphony of human and AI collaboration. This endpoint finds the perfect match of humans and agents possessing the required capabilities, ensuring every task is routed to the right hands or silicon minds. It's the beating heart of an ecosystem where skills and needs intersect seamlessly.
| requiredCapabilities required | Array of strings List of capability URIs that the task requires. |
object Additional context about the task to aid in capability matching. |
Requesting a match for capabilities required to process invoices.
{- "requiredCapabilities": [
- "capability://finance/invoice-processing",
- "capability://ai/ocr"
], - "taskContext": {
- "priority": "high",
- "dueDate": "2023-11-15T00:00:00Z"
}
}nullUncover the intricate web of skills and capabilities that a human agent possesses through their Passport. This endpoint allows organizations to map out and understand the dynamic capabilities of their team, enabling strategic task assignments and growth opportunities.
nullIn the bustling ecosystem of HUMAN, skill allocation is paramount. This endpoint empowers administrators to enhance their agents by granting them new capabilities, thus expanding their skillset within the Capability Graph. It's the bridge to a more knowledgeable future, ensuring that agents are always equipped to tackle the tasks of tomorrow.
| agentDID required | string Decentralized Identifier of the agent. |
| capabilities required | Array of strings |
Assigns the 'process invoices' capability to an agent within the 'acme' organization.
{- "agentDID": "did:example:123456789abcdefghi",
- "capabilities": [
- "capability://finance/invoice-processing"
]
}nullIn the ever-evolving landscape of AI and human collaboration, it's crucial to manage skills effectively. This endpoint allows you to revoke a specific grant from the Capability Graph, ensuring that only authorized skills remain active. By maintaining control over skill grants, HUMAN ensures a secure and efficient orchestration of tasks between humans and AI.
nullnullIn the HUMAN platform, skills are the currency of capability. This endpoint allows you to verify whether a set of skills, represented as nodes within the Capability Graph, are valid and recognized by the system. Verification ensures that agents possess the necessary skills required to execute tasks effectively, maintaining integrity and trust within the ecosystem.
| skills required | Array of strings An array of skill URIs to verify. |
This example demonstrates verifying a set of skills for the 'acme' organization.
{- "skills": [
- "capability://acme/invoice-processing",
- "capability://acme/data-entry"
]
}nullIn the ever-evolving landscape of AI and human collaboration, it's crucial to manage skills effectively. This endpoint allows you to revoke a specific grant from the Capability Graph, ensuring that only authorized skills remain active. By maintaining control over skill grants, HUMAN ensures a secure and efficient orchestration of tasks between humans and AI.
nullnullIn the HUMAN platform, skills are the currency of capability. This endpoint allows you to verify whether a set of skills, represented as nodes within the Capability Graph, are valid and recognized by the system. Verification ensures that agents possess the necessary skills required to execute tasks effectively, maintaining integrity and trust within the ecosystem.
| skills required | Array of strings An array of skill URIs to verify. |
This example demonstrates verifying a set of skills for the 'acme' organization.
{- "skills": [
- "capability://acme/invoice-processing",
- "capability://acme/data-entry"
]
}nullIn the HUMAN ecosystem, linking your Passport to an organization is pivotal. This endpoint empowers users to verify their email using a 6-digit code, completing the Passport-to-org linkage and triggering a trust attestation. It's where your digital identity begins to truly resonate with the HUMAN network.
| verificationCode required | string^[0-9]{6}$ 6-digit code sent to the user's email. |
A user verifies their email with a correct code.
{- "verificationCode": "123456"
}{- "message": "Email verified successfully, Passport linked to organization."
}Dive into the universe of skills with the HUMAN platform by exploring all available capability definitions. These definitions are the blueprint of what tasks can be orchestrated through HumanOS, offering a comprehensive view of the skills tracked within the Capability Graph. This endpoint empowers organizations to understand and harness the full potential of their human and AI resources.
nullAn example list of capability definitions, showcasing the diverse skill sets within an organization.
[- {
- "capabilityId": "capability://acme/invoice-processing",
- "name": "Invoice Processing",
- "description": "Automated handling and processing of invoices for efficiency and accuracy."
}, - {
- "capabilityId": "capability://acme/data-analysis",
- "name": "Data Analysis",
- "description": "Advanced data analysis for deriving actionable insights from complex datasets."
}
]In the intricate dance of Human-AI collaboration, defining capabilities is like setting the stage for a symphony. This endpoint allows you to introduce new skills into the Capability Graph, ensuring your AI agents are equipped to handle the evolving tasks of tomorrow. By defining capabilities, you enable precise skill tracking and efficient task routing across your organization.
| capabilityId required | string A unique identifier for the capability, following the format: capability:// |
| name required | string A human-readable name for the capability. |
| description required | string A detailed description of what the capability entails. |
| tags | Array of strings Tags to categorize the capability for easy search and retrieval. |
Shows how to define a new capability for processing invoices in 'acme' organization.
{- "capabilityId": "capability://acme/invoice-processing",
- "name": "Invoice Processing",
- "description": "Capability to process and validate invoices within the Acme Corporation.",
- "tags": [
- "finance",
- "invoice",
- "processing"
]
}nullIntegrate new capabilities into your HUMAN network with ease, ensuring that each skill is precisely tracked within your Capability Graph. This endpoint empowers organizations like 'acme' to seamlessly update their skill sets, fostering a dynamic and adaptable workforce in an ever-evolving landscape.
required | Array of objects |
This example demonstrates importing a set of new capabilities for an organization.
{- "capabilityDefinitions": [
- {
- "name": "Data Processing",
- "description": "Processes large datasets efficiently.",
- "version": "1.0",
- "skills": [
- "data-cleaning",
- "data-transformation"
]
}, - {
- "name": "AI Moderation",
- "description": "Moderates content using AI algorithms.",
- "version": "2.5",
- "skills": [
- "content-analysis",
- "sentiment-analysis"
]
}
]
}Shows a successful import response.
{- "status": "success",
- "importedCount": 2
}In the HUMAN ecosystem, connectors are the vital links that bind human skills with AI capabilities. This endpoint allows you to explore the network of available connectors, ensuring your organization can efficiently orchestrate the best human and AI interactions. Discover new pathways to enhance productivity and innovation.
nullA list of available connectors for the 'acme' organization.
[- {
- "connectorId": "connector-123",
- "name": "Acme Data Processor",
- "status": "active",
- "capabilities": [
- "capability://data-entry",
- "capability://invoice-processing"
]
}, - {
- "connectorId": "connector-456",
- "name": "Acme AI Translator",
- "status": "inactive",
- "capabilities": [
- "capability://language-translation"
]
}
]In the interconnected world of HUMAN, connectors serve as vital bridges, linking diverse data streams to the Human-AI Orchestration Protocol. This endpoint empowers organizations to forge these connections, facilitating seamless integration and unlocking new capabilities. By creating a connector, you ensure that your data flows are kept in harmony, nurturing the synergy between human skills and AI intelligence.
| orgId required | string The unique identifier for the organization. |
| connectorName required | string A descriptive name for the connector. |
| connectorType required | string The type of data stream the connector will handle. |
required | object Connector-specific configuration settings. |
Creating a simple connector for invoice processing.
{- "orgId": "acme-inc",
- "connectorName": "Invoice Stream",
- "connectorType": "invoice-processing",
}nullIn the dynamic world of Human-AI collaboration, elevating a capability is akin to unlocking a new level in a game. This endpoint allows organizations to promote a capability definition, enabling it to be more broadly recognized and utilized within the HUMAN ecosystem. By doing so, you ensure that your capabilities remain at the forefront of technological advancement.
| reason required | string The justification for promoting this capability. |
This example shows how to promote a capability definition for AI data processing to enhance its visibility within the organization.
{- "reason": "Enhancing AI data processing to improve organizational efficiency."
}nullDive into the intricate web of interconnected skills and capabilities with our ontology package retrieval. This endpoint provides a gateway to understanding the various skill sets available within the HUMAN ecosystem, allowing you to harness the full potential of your human-AI collaboration.
nullA comprehensive package for handling data processing tasks.
nullDive into the heart of the HUMAN platform's knowledge framework by accessing a specific version of an ontology package. This endpoint allows users to retrieve detailed information about the skills and capabilities encoded within a particular package version, crucial for ensuring AI models and human agents operate with the most relevant, precise knowledge.
nullnullDive into the fabric of an organization's capabilities with HUMAN's skill ontologies. This endpoint lets you explore a detailed map of skills, enabling powerful insights for task routing and AI orchestration. Whether optimizing human-AI collaboration or simply understanding your team's strengths, this endpoint is your gateway.
nullSkills relating to AI task management and coordination.
nullDive into the intricate web of interconnected skills and capabilities with our ontology package retrieval. This endpoint provides a gateway to understanding the various skill sets available within the HUMAN ecosystem, allowing you to harness the full potential of your human-AI collaboration.
nullA comprehensive package for handling data processing tasks.
nullDive into the heart of the HUMAN platform's knowledge framework by accessing a specific version of an ontology package. This endpoint allows users to retrieve detailed information about the skills and capabilities encoded within a particular package version, crucial for ensuring AI models and human agents operate with the most relevant, precise knowledge.
nullnullDive into the fabric of an organization's capabilities with HUMAN's skill ontologies. This endpoint lets you explore a detailed map of skills, enabling powerful insights for task routing and AI orchestration. Whether optimizing human-AI collaboration or simply understanding your team's strengths, this endpoint is your gateway.
nullSkills relating to AI task management and coordination.
nullIn the intricate dance of business, every step matters—especially when it involves the people who make it all possible. This endpoint allows you to gracefully access a comprehensive list of employees within a specified organization, ensuring you have the insights needed to orchestrate team dynamics effectively. Empowered by the org:employees:read capability, it's your gateway to understanding your workforce.
null[- {
- "employeeId": "12345",
- "name": "Jane Doe",
- "role": "Software Engineer",
- "email": "jane.doe@acme.org"
}, - {
- "employeeId": "67890",
- "name": "John Smith",
- "role": "Product Manager",
- "email": "john.smith@acme.org"
}
]This endpoint serves as a bridge between an individual's cryptographic identity (Passport) and their organizational persona. By linking these identities, it streamlines the process of task allocation and skill tracking within the HUMAN network, ensuring that individuals can seamlessly transition between roles and responsibilities.
| linkingCode required | string A secure code provided for linking the Passport to the organization. |
| email required | string <email> Email address for sending the verification code. |
Demonstrates linking a Passport to an employee record at Acme Corporation.
{- "linkingCode": "abc123def456",
- "email": "john.doe@acme.com"
}nullIn the world of HUMAN, trust is the currency. This endpoint verifies capability proofs, ensuring that agents possess the skills they claim. By validating these cryptographic tokens, HUMAN fosters a reliable ecosystem where tasks are routed to the most capable agents, preserving the integrity of your operations.
| agentDid required | string Decentralized Identifier of the agent |
| capabilityProof required | string Cryptographic proof of capability |
| taskId required | string Identifier of the task that requires verification |
This example demonstrates verifying an agent's capability to process invoices for the 'acme' organization.
{- "agentDid": "did:human:123456789abcdefghi",
- "capabilityProof": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "taskId": "task-987654321"
}nullThis endpoint sets the stage for a new chapter in an employee's journey by creating their initial record. It's where the organization's commitment to its team begins, ensuring a seamless onboarding experience. A linking code is generated and an onboarding email is sent to the prospective employee, integrating them into the organization's ecosystem swiftly and securely.
| email required | string The email address of the employee to onboard. |
| role | string The role assigned to the employee within the organization. |
Creating a record for a new employee with their email and role.
{- "email": "john.doe@example.com",
- "role": "Data Analyst"
}nullThis endpoint sets the stage for a new chapter in an employee's journey by creating their initial record. It's where the organization's commitment to its team begins, ensuring a seamless onboarding experience. A linking code is generated and an onboarding email is sent to the prospective employee, integrating them into the organization's ecosystem swiftly and securely.
| email required | string The email address of the employee to onboard. |
| role | string The role assigned to the employee within the organization. |
Creating a record for a new employee with their email and role.
{- "email": "john.doe@example.com",
- "role": "Data Analyst"
}nullIn the intricate dance of business, every step matters—especially when it involves the people who make it all possible. This endpoint allows you to gracefully access a comprehensive list of employees within a specified organization, ensuring you have the insights needed to orchestrate team dynamics effectively. Empowered by the org:employees:read capability, it's your gateway to understanding your workforce.
null[- {
- "employeeId": "12345",
- "name": "Jane Doe",
- "role": "Software Engineer",
- "email": "jane.doe@acme.org"
}, - {
- "employeeId": "67890",
- "name": "John Smith",
- "role": "Product Manager",
- "email": "john.smith@acme.org"
}
]Unveil the tapestry of trust by fetching all attestations linked to a specific Passport. This endpoint empowers organizations to trace the provenance of capabilities, ensuring transparency and accountability within the HUMAN ecosystem.
[- {
- "attestationId": "att123",
- "skill": "AI Engineering",
- "issuer": "did:human:acme123",
- "timestamp": "2023-10-01T12:34:56Z"
}, - {
- "attestationId": "att456",
- "skill": "Data Analysis",
- "issuer": "did:human:acme123",
- "timestamp": "2023-09-15T09:21:30Z"
}
]In the vast network of human-AI collaboration, delegation tokens play a pivotal role. This endpoint allows you to retrieve detailed information about a specific delegation token using its unique identifier. Understanding the provenance and capabilities tied to these tokens is crucial for ensuring secure and efficient task orchestration in the HUMAN ecosystem.
nullnullIn a world where trust is paramount, the /v1/delegation-tokens/by-delegation/:id endpoint serves as a digital detective. It meticulously sifts through the cryptographic archives of HUMAN to fetch delegation tokens associated with a specific ID, ensuring that every transaction and delegation is accounted for with precision and clarity.
nullnullUnlock the intricacies of HUMAN's orchestration by retrieving the permissions that define task capabilities. This endpoint empowers organizations like 'Acme Corp' to fine-tune their orchestration protocols by understanding who can do what, thereby ensuring AI safety and optimal task routing.
This example illustrates that no request body is necessary for this GET endpoint.
{ }nullUnlock the intricacies of HUMAN's orchestration by retrieving the permissions that define task capabilities. This endpoint empowers organizations like 'Acme Corp' to fine-tune their orchestration protocols by understanding who can do what, thereby ensuring AI safety and optimal task routing.
This example illustrates that no request body is necessary for this GET endpoint.
{ }nullIn the bustling marketplace of AI and human collaboration, this endpoint stands as the grand bazaar entrance. It routes your agent requests through the HumanOS, ensuring every call is matched to the right capabilities, evaluated for risk, and checked against policy. By replacing individual agent endpoints with a unified gateway, it simplifies management and enhances security.
| agentUri required | string The URI of the agent to be invoked |
| capabilityUri required | string The specific capability URI to be called |
| passport required | string Cryptographic identity of the requester |
| parameters | object Parameters required for the agent invocation |
Invoke an agent to process invoices for 'acme' organization.
{- "agentUri": "agent://acme.invoice.processor",
- "capabilityUri": "capability://invoice.processing",
- "passport": "did:human:123456789abcdefghi",
- "parameters": {
- "invoiceId": "INV-001"
}
}nullUnravel the journey of a workflow through the HUMAN platform with this endpoint. Dive deep into the provenance of your tasks to understand how they were orchestrated by HumanOS. This traceability ensures transparency, accountability, and integrity within your operations.
The /v1/events endpoint opens a gateway to the dynamic world of provenance tracking within the HUMAN ecosystem. As humans and AI collaborate, every action leaves a breadcrumb trail of events. This endpoint allows you to retrieve these events, providing transparency and trust in the orchestration process. Dive into the flow of activities and discover the narrative behind every task completion and modification.
nullnullDive into the depths of data origins with our provenance query endpoint. This tool empowers organizations like 'Acme Corp' to trace the lineage of their data, ensuring transparency and trust in every byte processed. By connecting the dots of past transactions, you gain unparalleled insight into your data's journey.
| query required | string The query string used to search the provenance records. |
object | |
| limit | integer The maximum number of records to return. |
An example showing a simple provenance query with a filter.
{- "query": "SELECT * FROM provenance WHERE agent='acme'",
- "filters": {
- "dateRange": "2023-01-01 to 2023-12-31"
}, - "limit": 100
}nullIn a world where trust is paramount, this endpoint allows organizations to cryptographically attest to the integrity of their data provenance records. By doing so, it ensures that every transaction and interaction involving human and AI agents is securely recorded, maintaining accountability throughout the process.
| agentId required | string The unique identifier of the agent making the attestation. |
| organizationId required | string The unique identifier of the organization responsible for the provenance record. |
| recordHash required | string The cryptographic hash of the data being attested. |
| timestamp required | string <date-time> The ISO 8601 timestamp when the attestation is made. |
An example of an organization attesting to the integrity of an invoice processing record.
{- "agentId": "agent123",
- "organizationId": "org-acme",
- "recordHash": "abc123def456ghi789",
- "timestamp": "2023-10-01T12:00:00Z"
}nullIn the HUMAN ecosystem, connectors are the vital links that bind human skills with AI capabilities. This endpoint allows you to explore the network of available connectors, ensuring your organization can efficiently orchestrate the best human and AI interactions. Discover new pathways to enhance productivity and innovation.
nullA list of available connectors for the 'acme' organization.
[- {
- "connectorId": "connector-123",
- "name": "Acme Data Processor",
- "status": "active",
- "capabilities": [
- "capability://data-entry",
- "capability://invoice-processing"
]
}, - {
- "connectorId": "connector-456",
- "name": "Acme AI Translator",
- "status": "inactive",
- "capabilities": [
- "capability://language-translation"
]
}
]In the interconnected world of HUMAN, connectors serve as vital bridges, linking diverse data streams to the Human-AI Orchestration Protocol. This endpoint empowers organizations to forge these connections, facilitating seamless integration and unlocking new capabilities. By creating a connector, you ensure that your data flows are kept in harmony, nurturing the synergy between human skills and AI intelligence.
| orgId required | string The unique identifier for the organization. |
| connectorName required | string A descriptive name for the connector. |
| connectorType required | string The type of data stream the connector will handle. |
required | object Connector-specific configuration settings. |
Creating a simple connector for invoice processing.
{- "orgId": "acme-inc",
- "connectorName": "Invoice Stream",
- "connectorType": "invoice-processing",
}nullIn the sprawling network of human and AI collaboration, connectors are the bridges enabling seamless communication. This endpoint allows you to retrieve detailed information about a specific connector using its unique identifier, ensuring transparency and trust in the HUMAN ecosystem.
nullnullDive into the vibrant ecosystem of HUMAN by exploring its agents—entities imbued with skills and ready to undertake tasks. This endpoint unveils the myriad of agents within the HUMAN network, each identified by a unique Passport, offering insights into their capabilities and readiness to collaborate.
null[- {
- "passportId": "passport-12345",
- "capabilities": [
- "capability://image-processing",
- "capability://data-entry"
], - "status": "active"
}, - {
- "passportId": "passport-67890",
- "capabilities": [
- "capability://natural-language-processing"
], - "status": "inactive"
}
]Discover the capabilities and identity of a specific agent within the HUMAN ecosystem. This endpoint allows you to access detailed information about an agent, tracked through the HUMAN Passport and Capability Graph, to understand its roles and functions. Uncover how agents are orchestrated to perform tasks safely and transparently.
nullnullIn the fast-paced world of AI, the ability to deploy agents swiftly and securely is paramount. This endpoint allows organizations to seamlessly transition their AI agents from development to production, ensuring they are ready to tackle real-world tasks with precision and safety.
| environment required | string The target environment for deployment (e.g., 'production', 'staging'). |
| version required | string The version of the agent to deploy. |
object Additional configuration parameters specific to the agent. |
Deploys version 3.1 of the 'InvoiceProcessor' agent to the production environment.
{- "environment": "production",
- "version": "3.1",
- "parameters": {
- "maxThreads": 10,
- "logLevel": "info"
}
}nullThis endpoint allows you to call a specific agent using its unique identifier. It's a remnant from our earlier architecture, preserved for those needing compatibility with older systems, and will eventually make way for the more versatile /v1/agents/call. Use it to ensure legacy systems continue to function without interruption.
| task required | string The specific task to be executed by the agent |
object Parameters required for the task execution |
Calls an agent to process invoice data for 'acme' organization
{- "task": "processInvoices",
- "parameters": {
- "orgId": "acme",
- "invoiceDate": "2023-10-15"
}
}nullDive into the vibrant ecosystem of HUMAN by exploring its agents—entities imbued with skills and ready to undertake tasks. This endpoint unveils the myriad of agents within the HUMAN network, each identified by a unique Passport, offering insights into their capabilities and readiness to collaborate.
null[- {
- "passportId": "passport-12345",
- "capabilities": [
- "capability://image-processing",
- "capability://data-entry"
], - "status": "active"
}, - {
- "passportId": "passport-67890",
- "capabilities": [
- "capability://natural-language-processing"
], - "status": "inactive"
}
]In the fast-paced world of AI, the ability to deploy agents swiftly and securely is paramount. This endpoint allows organizations to seamlessly transition their AI agents from development to production, ensuring they are ready to tackle real-world tasks with precision and safety.
| environment required | string The target environment for deployment (e.g., 'production', 'staging'). |
| version required | string The version of the agent to deploy. |
object Additional configuration parameters specific to the agent. |
Deploys version 3.1 of the 'InvoiceProcessor' agent to the production environment.
{- "environment": "production",
- "version": "3.1",
- "parameters": {
- "maxThreads": 10,
- "logLevel": "info"
}
}nullIn the bustling marketplace of AI and human collaboration, this endpoint stands as the grand bazaar entrance. It routes your agent requests through the HumanOS, ensuring every call is matched to the right capabilities, evaluated for risk, and checked against policy. By replacing individual agent endpoints with a unified gateway, it simplifies management and enhances security.
| agentUri required | string The URI of the agent to be invoked |
| capabilityUri required | string The specific capability URI to be called |
| passport required | string Cryptographic identity of the requester |
| parameters | object Parameters required for the agent invocation |
Invoke an agent to process invoices for 'acme' organization.
{- "agentUri": "agent://acme.invoice.processor",
- "capabilityUri": "capability://invoice.processing",
- "passport": "did:human:123456789abcdefghi",
- "parameters": {
- "invoiceId": "INV-001"
}
}nullIn the bustling world of Human-AI orchestration, understanding the status of ongoing tasks is crucial. This endpoint allows clients to poll asynchronously for the status of a specific execution, ensuring seamless task management and progress tracking within the HUMAN ecosystem.
nullnullUncover the story behind your asynchronous tasks with this endpoint. It provides a window into the ongoing operations handled by HUMAN's orchestration protocol, ensuring you stay informed and in control of complex workflows.
nullnullIn the bustling world of Human-AI orchestration, understanding the status of ongoing tasks is crucial. This endpoint allows clients to poll asynchronously for the status of a specific execution, ensuring seamless task management and progress tracking within the HUMAN ecosystem.
nullnullUncover the story behind your asynchronous tasks with this endpoint. It provides a window into the ongoing operations handled by HUMAN's orchestration protocol, ensuring you stay informed and in control of complex workflows.
nullnullIn the intricate dance of human-AI collaboration, understanding the status of your delegations is crucial. This endpoint provides real-time insights into the current state of a specific delegation, ensuring transparency and enabling proactive orchestration within the HUMAN ecosystem.
nullnullReturns a cursor-paginated list of approval requests. Supports filtering by status, approver, requester, and agent.
| status | string Enum: "pending" "approved" "rejected" "expired" "cancelled" Filter by approval status |
| approver | string Filter by approver passport DID |
| requester | string Filter by requester passport DID |
| agent_id | string Filter by agent ID |
| limit | integer [ 1 .. 100 ] Default: 20 Maximum number of results (1-100) |
| cursor | string <date-time> Cursor for pagination (ISO 8601 timestamp) |
{- "data": [
- {
- "id": "approval_abc123",
- "task_id": "task_def456",
- "agent_id": "agent://org/acme/processor@v1",
- "requester_passport_id": "did:human:requester123",
- "approver_passport_id": "did:human:approver456",
- "action_description": "Process high-value payment",
- "risk_level": "low",
- "risk_factors": [
- {
- "factor": "string",
- "severity": "low"
}
], - "request_data": { },
- "status": "pending",
- "responded_by": "string",
- "response_comment": "string",
- "modified_params": { },
- "alternatives": [
- { }
], - "created_at": "2019-08-24T14:15:22Z",
- "responded_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z"
}
], - "has_more": true,
- "next_cursor": "string"
}Retrieve details of a specific approval request
| id required | string Approval request ID |
{- "id": "approval_abc123",
- "task_id": "task_def456",
- "agent_id": "agent://org/acme/processor@v1",
- "requester_passport_id": "did:human:requester123",
- "approver_passport_id": "did:human:approver456",
- "action_description": "Process high-value payment",
- "risk_level": "low",
- "risk_factors": [
- {
- "factor": "string",
- "severity": "low"
}
], - "request_data": { },
- "status": "pending",
- "responded_by": "string",
- "response_comment": "string",
- "modified_params": { },
- "alternatives": [
- { }
], - "created_at": "2019-08-24T14:15:22Z",
- "responded_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z"
}Approve, reject, or modify an approval request
| id required | string Approval request ID |
| decision required | string Enum: "approved" "rejected" Approval decision |
| responded_by required | string Passport DID of responder |
| comment | string Optional comment |
| modified_params | object Modified parameters (if approved with changes) |
{- "decision": "approved",
- "responded_by": "string",
- "comment": "string",
- "modified_params": { }
}{- "id": "approval_abc123",
- "task_id": "task_def456",
- "agent_id": "agent://org/acme/processor@v1",
- "requester_passport_id": "did:human:requester123",
- "approver_passport_id": "did:human:approver456",
- "action_description": "Process high-value payment",
- "risk_level": "low",
- "risk_factors": [
- {
- "factor": "string",
- "severity": "low"
}
], - "request_data": { },
- "status": "pending",
- "responded_by": "string",
- "response_comment": "string",
- "modified_params": { },
- "alternatives": [
- { }
], - "created_at": "2019-08-24T14:15:22Z",
- "responded_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z"
}Cancel a pending approval request
| id required | string Approval request ID |
| cancelled_by required | string Passport DID of canceller |
| reason | string Cancellation reason |
{- "cancelled_by": "string",
- "reason": "string"
}{- "id": "approval_abc123",
- "task_id": "task_def456",
- "agent_id": "agent://org/acme/processor@v1",
- "requester_passport_id": "did:human:requester123",
- "approver_passport_id": "did:human:approver456",
- "action_description": "Process high-value payment",
- "risk_level": "low",
- "risk_factors": [
- {
- "factor": "string",
- "severity": "low"
}
], - "request_data": { },
- "status": "pending",
- "responded_by": "string",
- "response_comment": "string",
- "modified_params": { },
- "alternatives": [
- { }
], - "created_at": "2019-08-24T14:15:22Z",
- "responded_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z"
}In the vast orchestration of human and AI tasks, understanding the status and details of approval requests is crucial. This endpoint allows you to delve into the specifics of an approval request, ensuring transparency and informed decision-making in your workflows.
nullnullIn the dynamic world of task orchestration, decisions often hinge on timely approvals. This endpoint empowers agents to swiftly approve or reject requests, ensuring smooth human-AI collaboration. It embodies the trust and efficiency that the HUMAN platform promises.
| decision required | string Enum: "approve" "reject" The decision made on the approval request. |
| reason | string Optional explanation for the decision. |
This example demonstrates approving a request with a detailed reason.
{- "decision": "approve",
- "reason": "All criteria met for expedited processing."
}nullIn the dynamic dance of decision-making, sometimes a pause or pivot is necessary. This endpoint allows you to gracefully cancel a pending approval, ensuring resources are reallocated efficiently and tasks are redirected as organizational priorities shift.
| reason | string Optional reason for cancelation. |
Cancelling an approval with a given reason for documentation.
{- "reason": "Budget reallocation to urgent project"
}The response after a successful cancellation of an approval.
{- "status": "success",
- "message": "Approval request canceled successfully."
}In the vast orchestration of human and AI tasks, understanding the status and details of approval requests is crucial. This endpoint allows you to delve into the specifics of an approval request, ensuring transparency and informed decision-making in your workflows.
nullnullIn the dynamic dance of decision-making, sometimes a pause or pivot is necessary. This endpoint allows you to gracefully cancel a pending approval, ensuring resources are reallocated efficiently and tasks are redirected as organizational priorities shift.
| reason | string Optional reason for cancelation. |
Cancelling an approval with a given reason for documentation.
{- "reason": "Budget reallocation to urgent project"
}The response after a successful cancellation of an approval.
{- "status": "success",
- "message": "Approval request canceled successfully."
}In the dynamic world of task orchestration, decisions often hinge on timely approvals. This endpoint empowers agents to swiftly approve or reject requests, ensuring smooth human-AI collaboration. It embodies the trust and efficiency that the HUMAN platform promises.
| decision required | string Enum: "approve" "reject" The decision made on the approval request. |
| reason | string Optional explanation for the decision. |
This example demonstrates approving a request with a detailed reason.
{- "decision": "approve",
- "reason": "All criteria met for expedited processing."
}nullIn the dynamic world of HUMAN's orchestration, tasks sometimes need a change of course. This endpoint empowers you to halt a queued execution before it begins, safeguarding resources and adapting to real-time needs. Whether it's a pivot in strategy or an error in setup, cancelling ensures your operations remain fluid and efficient.
| reason | string Optional explanation for the cancellation, aiding in audit and review processes. |
Cancelling an execution because a more urgent task has taken precedence.
{- "reason": "Higher priority task available"
}nullEmpower your HUMAN ecosystem by orchestrating tasks efficiently. This endpoint allows you to submit new tasks to the HUMAN workforce, ensuring they're routed correctly using HumanOS. It exists to streamline task management, leveraging AI safety protocols to allocate tasks to the right agents securely.
In the bustling world of the HUMAN platform, knowing the status of a task ensures seamless coordination between AI and human agents. This endpoint provides a window into the task's journey, allowing users to track progress, identify bottlenecks, and ensure timely completion.
nullReturns a cursor-paginated list of async execution jobs
| status | string Enum: "queued" "processing" "completed" "failed" "cancelled" Filter by execution status |
| agent_id | string Filter by agent ID |
| limit | integer [ 1 .. 100 ] Default: 20 |
| cursor | string <date-time> |
{- "data": [
- {
- "id": "exec_abc123",
- "task_id": "string",
- "agent_id": "string",
- "requester_passport_id": "string",
- "status": "queued",
- "result_json": { },
- "error_json": { },
- "progress_percent": 100,
- "progress_message": "string",
- "callback_url": "string",
- "callback_success": true,
- "callback_attempts": 0,
- "max_attempts": 0,
- "current_attempt": 0,
- "queued_at": "2019-08-24T14:15:22Z",
- "started_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "provenance_id": "string"
}
], - "has_more": true,
- "next_cursor": "string"
}Retrieve status and results of an async execution
| id required | string Execution ID |
{- "id": "exec_abc123",
- "task_id": "string",
- "agent_id": "string",
- "requester_passport_id": "string",
- "status": "queued",
- "result_json": { },
- "error_json": { },
- "progress_percent": 100,
- "progress_message": "string",
- "callback_url": "string",
- "callback_success": true,
- "callback_attempts": 0,
- "max_attempts": 0,
- "current_attempt": 0,
- "queued_at": "2019-08-24T14:15:22Z",
- "started_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "provenance_id": "string"
}Cancel a queued or processing execution
| id required | string Execution ID |
| cancelled_by required | string Passport DID of canceller |
| reason | string Cancellation reason |
{- "cancelled_by": "string",
- "reason": "string"
}{- "id": "exec_abc123",
- "task_id": "string",
- "agent_id": "string",
- "requester_passport_id": "string",
- "status": "queued",
- "result_json": { },
- "error_json": { },
- "progress_percent": 100,
- "progress_message": "string",
- "callback_url": "string",
- "callback_success": true,
- "callback_attempts": 0,
- "max_attempts": 0,
- "current_attempt": 0,
- "queued_at": "2019-08-24T14:15:22Z",
- "started_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "provenance_id": "string"
}In the dynamic world of HUMAN's orchestration, tasks sometimes need a change of course. This endpoint empowers you to halt a queued execution before it begins, safeguarding resources and adapting to real-time needs. Whether it's a pivot in strategy or an error in setup, cancelling ensures your operations remain fluid and efficient.
| reason | string Optional explanation for the cancellation, aiding in audit and review processes. |
Cancelling an execution because a more urgent task has taken precedence.
{- "reason": "Higher priority task available"
}nullUnravel the complexity of your processes by fetching the workflow's Directed Acyclic Graph (DAG). This endpoint enables you to visualize and understand the intricate orchestration of tasks within the HUMAN platform, ensuring clarity and enhancing collaboration between AI and human agents.
nullnullUncover the hidden story behind your workflows with detailed execution statistics. This endpoint provides a window into performance metrics, helping you orchestrate Human-AI tasks more effectively by understanding past behavior.
nullnullUnravel the complexity of your processes by fetching the workflow's Directed Acyclic Graph (DAG). This endpoint enables you to visualize and understand the intricate orchestration of tasks within the HUMAN platform, ensuring clarity and enhancing collaboration between AI and human agents.
nullnullUncover the hidden story behind your workflows with detailed execution statistics. This endpoint provides a window into performance metrics, helping you orchestrate Human-AI tasks more effectively by understanding past behavior.
nullnullIn the intricate dance of human and AI orchestration, sometimes a delegate's role must be rescinded. This endpoint enables the termination of a specific delegation, ensuring that control is returned to the rightful originator. It's a crucial mechanism for safeguarding the integrity of tasks and capabilities within the HUMAN Protocol's Capability Graph.
| reason required | string The rationale for revoking the delegation, aiding in audit trails. |
Demonstrates revoking a delegation due to a suspected security breach.
{- "reason": "Suspicion of unauthorized access to sensitive data."
}nullReturns a cursor-paginated list of revoked delegations
| revoked_by | string Filter by revoker DID |
| since | string <date-time> Filter by revocation date |
| limit | integer [ 1 .. 100 ] Default: 20 |
| cursor | string <date-time> |
{- "data": [
- {
- "id": "string",
- "delegation_id": "string",
- "revoked_by": "string",
- "revoked_at": "2019-08-24T14:15:22Z",
- "reason": "string",
- "metadata": { }
}
], - "has_more": true,
- "next_cursor": "string"
}Revoke a delegation token permanently
| id required | string Delegation ID |
| revoked_by required | string Passport DID of revoker |
| reason | string Revocation reason |
| metadata | object Optional metadata |
{- "revoked_by": "string",
- "reason": "string",
- "metadata": { }
}{- "id": "string",
- "delegation_id": "string",
- "revoked_by": "string",
- "revoked_at": "2019-08-24T14:15:22Z",
- "reason": "string",
- "metadata": { }
}Check if a delegation is valid or revoked
| id required | string Delegation ID |
{- "delegation_id": "string",
- "is_revoked": true,
- "revocation": {
- "id": "string",
- "delegation_id": "string",
- "revoked_by": "string",
- "revoked_at": "2019-08-24T14:15:22Z",
- "reason": "string",
- "metadata": { }
}
}In the intricate dance of human-AI collaboration, understanding the status of your delegations is crucial. This endpoint provides real-time insights into the current state of a specific delegation, ensuring transparency and enabling proactive orchestration within the HUMAN ecosystem.
nullnullThis endpoint allows you to call a specific agent using its unique identifier. It's a remnant from our earlier architecture, preserved for those needing compatibility with older systems, and will eventually make way for the more versatile /v1/agents/call. Use it to ensure legacy systems continue to function without interruption.
| task required | string The specific task to be executed by the agent |
object Parameters required for the task execution |
Calls an agent to process invoice data for 'acme' organization
{- "task": "processInvoices",
- "parameters": {
- "orgId": "acme",
- "invoiceDate": "2023-10-15"
}
}nullEmpower your HUMAN ecosystem by orchestrating tasks efficiently. This endpoint allows you to submit new tasks to the HUMAN workforce, ensuring they're routed correctly using HumanOS. It exists to streamline task management, leveraging AI safety protocols to allocate tasks to the right agents securely.
In the heart of HUMAN's orchestration, retrieving a task by ID is akin to summoning the exact piece of the puzzle you need. This endpoint exists to enable seamless task management, allowing you to fetch precise details about a task, ensuring that both human and AI agents can collaborate effectively.
nullValidate and process the invoice received from ACME Corporation.
nullIn the bustling world of the HUMAN platform, knowing the status of a task ensures seamless coordination between AI and human agents. This endpoint provides a window into the task's journey, allowing users to track progress, identify bottlenecks, and ensure timely completion.
nullIn the heart of HUMAN's orchestration, retrieving a task by ID is akin to summoning the exact piece of the puzzle you need. This endpoint exists to enable seamless task management, allowing you to fetch precise details about a task, ensuring that both human and AI agents can collaborate effectively.
nullValidate and process the invoice received from ACME Corporation.
nullDive into a world of learning with our vast array of courses. This endpoint empowers users to explore a curated list of educational courses, each a gateway to knowledge and skill enhancement. Whether you're a novice seeking to learn or an expert wanting to expand your horizons, this endpoint connects you to the right resources.
nullDeep dive into complex data structures and their applications.
nullDive into a world of learning with our vast array of courses. This endpoint empowers users to explore a curated list of educational courses, each a gateway to knowledge and skill enhancement. Whether you're a novice seeking to learn or an expert wanting to expand your horizons, this endpoint connects you to the right resources.
nullDeep dive into complex data structures and their applications.
nullIn the ever-evolving landscape of knowledge, the academy serves as a beacon of enlightenment. This endpoint empowers organizations to expand their educational repertoire by creating new courses, seamlessly integrating with the HUMAN platform's robust identity and capability features. Imagine crafting a curriculum that not only imparts knowledge but also tracks the skills, using the HUMAN Capability Graph.
| title required | string The title of the course, capturing its essence. |
| description required | string A brief overview of what the course entails. |
| capabilities | Array of strings |
This example demonstrates the creation of an 'Advanced AI' course, encapsulating the futuristic capabilities of AI development.
{- "title": "Advanced AI",
- "description": "An in-depth exploration of AI algorithms and models.",
- "capabilities": [
- "capability://ai/development",
- "capability://machine-learning"
]
}nullIn the ever-evolving landscape of knowledge, the academy serves as a beacon of enlightenment. This endpoint empowers organizations to expand their educational repertoire by creating new courses, seamlessly integrating with the HUMAN platform's robust identity and capability features. Imagine crafting a curriculum that not only imparts knowledge but also tracks the skills, using the HUMAN Capability Graph.
| title required | string The title of the course, capturing its essence. |
| description required | string A brief overview of what the course entails. |
| capabilities | Array of strings |
This example demonstrates the creation of an 'Advanced AI' course, encapsulating the futuristic capabilities of AI development.
{- "title": "Advanced AI",
- "description": "An in-depth exploration of AI algorithms and models.",
- "capabilities": [
- "capability://ai/development",
- "capability://machine-learning"
]
}nullReturns a cursor-paginated list of workflow DAGs
| status | string Enum: "pending" "running" "completed" "failed" Filter by workflow status |
| agent_id | string Filter by agent ID |
| limit | integer [ 1 .. 100 ] Default: 20 |
| cursor | string <date-time> |
{- "data": [
- {
- "workflow_id": "string",
- "root_node": {
- "id": "string",
- "status": "string",
- "created_at": "2019-08-24T14:15:22Z"
}, - "stats": {
- "total_nodes": 0,
- "completed": 0,
- "failed": 0,
- "running": 0,
- "pending": 0,
- "total_duration_ms": 0,
- "avg_node_duration_ms": 0
}
}
], - "has_more": true,
- "next_cursor": "string"
}Retrieve complete workflow DAG with nodes and edges
| id required | string Workflow ID |
{- "workflow_id": "string",
- "root_node": {
- "id": "string",
- "workflow_id": "string",
- "parent_node_id": "string",
- "node_type": "agent",
- "node_name": "string",
- "agent_id": "string",
- "agent_name": "string",
- "input": { },
- "output": { },
- "error": { },
- "status": "pending",
- "created_at": "2019-08-24T14:15:22Z",
- "started_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "duration_ms": 0,
- "visual_metadata": { },
- "provenance_id": "string",
- "execution_id": "string",
- "approval_id": "string"
}, - "nodes": [
- {
- "id": "string",
- "workflow_id": "string",
- "parent_node_id": "string",
- "node_type": "agent",
- "node_name": "string",
- "agent_id": "string",
- "agent_name": "string",
- "input": { },
- "output": { },
- "error": { },
- "status": "pending",
- "created_at": "2019-08-24T14:15:22Z",
- "started_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "duration_ms": 0,
- "visual_metadata": { },
- "provenance_id": "string",
- "execution_id": "string",
- "approval_id": "string"
}
], - "edges": [
- {
- "id": "string",
- "from_node_id": "string",
- "to_node_id": "string",
- "edge_type": "sequence",
- "condition": "string",
- "metadata": { }
}
], - "stats": {
- "total_nodes": 0,
- "completed": 0,
- "failed": 0,
- "running": 0,
- "pending": 0,
- "total_duration_ms": 0,
- "avg_node_duration_ms": 0
}
}Retrieve performance statistics for a workflow
| id required | string Workflow ID |
{- "total_nodes": 0,
- "completed": 0,
- "failed": 0,
- "running": 0,
- "pending": 0,
- "total_duration_ms": 0,
- "avg_node_duration_ms": 0
}Search and filter public connectors in the marketplace.
Authentication: Public (no auth required)
Features:
| query | string Example: query=google calendar Search query (matches name, description, provider) |
| provider | string Example: provider=google Filter by provider name |
| certified | boolean Filter by HUMAN-certified status |
| pricing_model | string Enum: "free" "paid" "freemium" Filter by pricing model |
| capability | string Example: capability=calendar.read Filter by capability ID |
| limit | integer [ 1 .. 100 ] Default: 20 Results per page (max 100) |
| cursor | string Pagination cursor from previous response |
{- "data": [
- {
- "connector_id": "conn_google_calendar",
- "name": "Google Calendar",
- "provider": "google",
- "description": "string",
- "version": "1.0.0",
- "publisher_id": "string",
- "certified": true,
- "pricing_model": "free",
- "capabilities": [
- "string"
], - "install_count": 0,
- "rating_average": 0.1,
- "rating_count": 0,
- "oauth": {
- "required": true,
- "scopes": [
- "string"
]
}, - "deployment_modes": [
- "cloud"
], - "health_status": "healthy",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "has_more": true,
- "next_cursor": "string"
}Get detailed information about a specific connector.
Authentication: Public (no auth required)
Includes:
| id required | string Example: conn_google_calendar Connector ID |
{- "connector_id": "string",
- "name": "string",
- "provider": "string",
- "description": "string",
- "long_description": "string",
- "version": "string",
- "publisher": {
- "publisher_id": "string",
- "name": "string",
- "verified": true
}, - "certified": true,
- "pricing_model": "free",
- "capabilities": [
- "string"
], - "oauth": {
- "required": true,
- "scopes": [
- "string"
],
}, - "deployment_modes": [
- "string"
], - "configuration_schema": { },
- "health_status": "healthy",
- "last_health_check_at": "2019-08-24T14:15:22Z",
- "statistics": {
- "install_count": 0,
- "rating_average": 0.1,
- "rating_count": 0,
- "invocation_count_30d": 0
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Install a connector for the current organization.
Authentication: Requires delegation token with org membership
OAuth Flow:
oauth_authorization_url/v1/oauth/callbackNon-OAuth Flow:
| id required | string Connector ID |
| deployment_mode required | string Enum: "cloud" "hybrid" "self-hosted" Deployment mode for connector |
object Connector-specific configuration | |
| granted_permissions required | Array of strings Permissions granted to connector |
{- "deployment_mode": "cloud",
- "config": { },
- "granted_permissions": [
- "string"
]
}{- "installation_id": "string",
- "connector_id": "string",
- "status": "pending_oauth",
- "oauth_state": "string",
- "expires_at": "2019-08-24T14:15:22Z"
}Uninstall a connector from the current organization.
Authentication: Requires delegation token with org membership
Effects:
| id required | string Connector ID |
{- "connector_id": "string",
- "status": "uninstalled",
- "uninstalled_at": "2019-08-24T14:15:22Z"
}Rate a connector (1-5 stars) with optional review text.
Authentication: Requires delegation token + verified installation
Rules:
| id required | string Connector ID |
| rating required | integer [ 1 .. 5 ] Star rating (1-5) |
| review_text | string <= 2000 characters Optional review text |
| installation_id required | string Installation ID to verify ownership |
{- "rating": 1,
- "review_text": "string",
- "installation_id": "string"
}{- "rating_id": "string",
- "rating": 1,
- "review_text": "string",
- "user": {
- "user_id": "string",
- "display_name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Get ratings and reviews for a connector.
Authentication: Public (no auth required)
Includes:
| id required | string Connector ID |
| limit | integer [ 1 .. 100 ] Default: 20 Results per page (max 100) |
| cursor | string Pagination cursor |
{- "data": [
- {
- "rating_id": "string",
- "rating": 1,
- "review_text": "string",
- "user": {
- "user_id": "string",
- "display_name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "has_more": true,
- "next_cursor": "string",
- "summary": {
- "average": 0.1,
- "count": 0,
- "distribution": {
- "1": 0,
- "2": 0,
- "3": 0,
- "4": 0,
- "5": 0
}
}
}List connectors installed for the current organization.
Authentication: Requires delegation token with org membership
Includes:
| status | string Enum: "active" "suspended" "uninstalled" Filter by installation status |
| limit | integer [ 1 .. 100 ] Default: 20 Results per page (max 100) |
| cursor | string Pagination cursor |
{- "data": [
- {
- "installation_id": "string",
- "connector": {
- "connector_id": "string",
- "name": "string",
- "provider": "string",
}, - "status": "active",
- "deployment_mode": "cloud",
- "config": { },
- "granted_permissions": [
- "string"
], - "health_status": "healthy",
- "installed_by": "string",
- "installed_at": "2019-08-24T14:15:22Z",
- "last_invocation_at": "2019-08-24T14:15:22Z",
- "invocation_count_30d": 0
}
], - "has_more": true,
- "next_cursor": "string"
}Update installation configuration or status.
Authentication: Requires delegation token with org membership
Updates:
| id required | string Installation ID |
| status | string Enum: "active" "suspended" New status |
object Updated configuration |
{- "status": "active",
- "config": { }
}{- "installation_id": "string",
- "status": "string",
- "config": { },
- "updated_at": "2019-08-24T14:15:22Z"
}Get 30-day usage statistics for an installation.
Authentication: Requires delegation token with org membership
Statistics:
| id required | string Installation ID |
{- "installation_id": "string",
- "connector_id": "string",
- "period": "30d",
- "statistics": {
- "total_invocations": 0,
- "successful_invocations": 0,
- "failed_invocations": 0,
- "average_duration_ms": 0.1,
- "total_cost_usd": 0.1,
- "last_invocation_at": "2019-08-24T14:15:22Z"
}, - "daily_breakdown": [
- {
- "date": "2019-08-24",
- "invocations": 0,
- "cost_usd": 0.1
}
]
}Handles OAuth callbacks from external providers (Google, Salesforce, etc.)
IMPORTANT: This is NOT for HUMAN authentication. This endpoint receives callbacks from EXTERNAL OAuth providers after a user authorizes a connector to access their external account.
Flow:
Security:
| code required | string Authorization code from external provider |
| state required | string OAuth state (CSRF protection) |
| error | string Error code (if authorization failed) |
| error_description | string Error description |
{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}Refresh an expired OAuth access token.
Authentication: Internal endpoint (used by connectors)
Note: This is currently a stub. Full implementation pending.
{- "access_token": "string",
- "expires_at": "2019-08-24T14:15:22Z"
}Exchanges a valid session token (from WebAuthn login) for a scoped delegation token that can be used as a Bearer token for all HUMΛN API endpoints. This is the final step in the authentication chain: Passkey → Session Token → Delegation Token.
The caller specifies which capabilities they need. The endpoint creates a self-delegation with the requested scope. Supports optional tier enforcement for verification and identity levels.
| capabilities | Array of strings Requested delegation capabilities. Defaults to reasoning + agents read/invoke if empty. |
| scopes | Array of strings Alias for capabilities (accepted for client convenience) |
| duration_seconds | integer [ 1 .. 2592000 ] Default: 86400 Token duration in seconds (max 30 days) |
| environment | string Optional environment constraint |
| risk_level | string Default: "standard" Enum: "low" "standard" "high" |
| required_verification_tier | integer Required passport verification tier (rejects if below) |
| required_identity_tier | integer Required passport identity tier (rejects if below) |
{- "duration_seconds": 86400
}{- "delegation_id": "string",
- "token": "string",
- "passport_id": "string",
- "did": "string",
- "capabilities": [
- "string"
], - "verification_tier": 0,
- "identity_tier": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z"
}Returns the protocol compliance status of this deployment, signed by the deployment key for verification by other nodes.
Checks whether the deployment meets HUMΛN protocol requirements: human passport minting uses device ceremony (not server fabrication), attestation format acceptance policy, and ledger sync status.
This endpoint is public — any node can check another node's compliance.
{- "deployment_id": "string",
- "protocol_version": "string",
- "compliance": {
- "human_passport_minting": "device_only",
- "attestation_formats_accepted": [
- "string"
], - "ledger_sync_status": "string",
- "passport_count": 0,
- "verification_count": 0,
- "last_compliance_check": "2019-08-24T14:15:22Z"
}, - "invariants": {
- "server_side_key_generation": true,
- "private_key_access": true,
- "biometric_binding_hash_used": true,
- "webauthn_required_for_humans": true
}, - "signature": "string"
}Returns whether this deployment's passports are verified by the broader HUMΛN network or only locally.
A "walled garden" deployment can create passports that work within its local environment but cannot interoperate with other HUMΛN deployments. This endpoint surfaces that distinction with mitigations and recommendations.
Canon: Validity Ladder Plan, Phase 3.5
{- "network_verification": "local_only",
- "explanation": "string",
- "mitigations": [
- "string"
], - "risks": {
- "walled_garden_possible": true,
- "blast_radius": "string",
- "risk_acceptance": "string"
}, - "recommendations": [
- "string"
]
}High-level reasoning endpoint implementing "Magic by Default" — the agent just says "I need to think" and HUMΛN handles model selection, cost optimization, delegation enforcement, and performance tracking.
The system analyzes task complexity, finds capable models, enforces delegation constraints, optimizes for cost/quality, and executes with full provenance logging.
required | Array of objects |
| task | string Enum: "reasoning" "coding" "summarization" "creative" "math" "general" |
| complexity | string Enum: "simple" "medium" "complex" |
| budget | string Default: "optimize" Enum: "minimize" "optimize" "unlimited" |
| pinned_model | string Override model selection with a specific model |
| entity_id | string Organization or entity for cost tracking |
| temperature | number [ 0 .. 2 ] |
| max_tokens | integer >= 1 |
{- "messages": [
- {
- "role": "user",
- "content": "Summarize this contract clause..."
}
], - "task": "summarization",
- "complexity": "simple",
- "budget": "minimize"
}{- "success": true,
- "data": {
- "model": "string",
- "provider": "string",
- "text": "string",
- "usage": {
- "inputTokens": 0,
- "outputTokens": 0,
- "totalTokens": 0
}
}, - "metadata": {
- "costUsd": 0,
- "durationMs": 0,
- "routingDecision": {
- "selected": "string",
- "reason": "string",
- "alternatives": [
- "string"
]
}
}
}Returns available models with their capabilities, cost information, and performance metrics. Supports filtering by provider, status, and minimum capability thresholds.
| provider | string Filter by provider (openai, anthropic) |
| status | string Default: "active" Enum: "active" "deprecated" "experimental" Filter by status |
| min_reasoning | number [ 0 .. 10 ] Minimum reasoning capability score (0-10) |
| min_coding | number [ 0 .. 10 ] Minimum coding capability score (0-10) |
{- "models": [
- {
- "model_id": "string",
- "provider": "string",
- "display_name": "string",
- "description": "string",
- "capabilities": {
- "reasoning": 0,
- "coding": 0,
- "summarization": 0,
- "multilingual": 0,
- "math_reasoning": 0,
- "creative_writing": 0,
- "instruction_following": 0
}, - "context_length": 0,
- "supports_streaming": true,
- "supports_function_calling": true,
- "supports_vision": true,
- "performance": {
- "avg_latency_ms": 0,
- "reliability": 0,
- "success_rate": 0
}, - "cost": {
- "input_cost_per_1k": 0,
- "output_cost_per_1k": 0
}, - "status": "active"
}
]
}Returns performance statistics for a specific model over the last 30 days, including success rate, latency, cost, and breakdown by task complexity.
| modelId required | string Model identifier |
{- "model_id": "string",
- "total_requests": 0,
- "success_rate": 0,
- "avg_latency_ms": 0,
- "avg_cost_usd": 0,
- "by_complexity": {
- "property1": {
- "count": 0,
- "success_rate": 0,
- "avg_cost": 0
}, - "property2": {
- "count": 0,
- "success_rate": 0,
- "avg_cost": 0
}
}
}Submit benchmark results for a model. Updates the model's benchmark count and last-benchmarked timestamp. Used by the system to track model quality over time.
| model_id required | string |
| benchmark_type required | string e.g., reasoning, coding, math |
| benchmark_suite required | string e.g., mmlu, humaneval, gsm8k |
| score required | number [ 0 .. 100 ] |
| run_at | string <date-time> |
| run_by | string |
| test_cases_passed | integer |
| test_cases_total | integer |
| raw_results | object |
{- "model_id": "string",
- "benchmark_type": "string",
- "benchmark_suite": "string",
- "score": 100,
- "run_at": "2019-08-24T14:15:22Z",
- "run_by": "string",
- "test_cases_passed": 0,
- "test_cases_total": 0,
- "raw_results": { }
}{- "id": "string",
- "model_id": "string",
- "benchmark_type": "string",
- "benchmark_suite": "string",
- "score": 0,
- "run_at": "2019-08-24T14:15:22Z",
- "run_by": "string",
- "test_cases_passed": 0,
- "test_cases_total": 0
}List prompts the caller has prompt:read scope for. Supports filtering by namespace and scope. Results are filtered by the caller's delegation permissions — only prompts matching granted prompt:read:* scopes are returned.
| namespace | string Filter by prompt namespace |
| scope | string Filter by visibility scope |
| limit | integer [ 1 .. 100 ] Default: 20 Maximum results per page (1-100) |
| cursor | string Cursor for pagination |
{- "data": [
- {
- "prompt_uri": "string",
- "prompt_key": "string",
- "org_id": "string",
- "scope": "string",
- "namespace": "string",
- "active_version": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "has_more": true,
- "next_cursor": "eyJpZCI6ImdyYW50XzEyMyJ9",
- "total_count": 487
}
}Get the currently active version of a prompt by key or URI. The key can be a short key (e.g., "companion.task.summarize") or a URL-encoded full URI (e.g., "prompt://org/ACME/companion.task.summarize").
Requires prompt:read:{key} delegation scope.
| key required | string Prompt key or URL-encoded URI |
{- "prompt_uri": "string",
- "prompt_key": "string",
- "org_id": "string",
- "version": "string",
- "content": "string",
- "meta": { },
- "input_schema": { },
- "extends_uri": "string",
- "published_by": "string",
- "published_at": "2019-08-24T14:15:22Z",
- "status": "active"
}List all versions of a prompt, ordered by version number. Requires prompt:read:{key} delegation scope.
| key required | string Prompt key or URL-encoded URI |
| limit | integer Default: 20 Maximum results per page |
{- "data": [
- {
- "prompt_uri": "string",
- "prompt_key": "string",
- "org_id": "string",
- "version": "string",
- "content": "string",
- "meta": { },
- "input_schema": { },
- "extends_uri": "string",
- "published_by": "string",
- "published_at": "2019-08-24T14:15:22Z",
- "status": "active"
}
], - "pagination": {
- "has_more": true,
- "next_cursor": "eyJpZCI6ImdyYW50XzEyMyJ9",
- "total_count": 487
}
}Get a specific version of a prompt by version number. Requires prompt:read:{key} delegation scope.
| key required | string Prompt key or URL-encoded URI |
| version required | string Semver version number |
{- "prompt_uri": "string",
- "prompt_key": "string",
- "org_id": "string",
- "version": "string",
- "content": "string",
- "meta": { },
- "input_schema": { },
- "extends_uri": "string",
- "published_by": "string",
- "published_at": "2019-08-24T14:15:22Z",
- "status": "active"
}Publish a new version of a prompt. Creates a new version record and sets it as the active version. If the prompt doesn't exist yet, it is created.
Requires prompt:publish:{key} delegation scope.
| key required | string Prompt key |
| version required | string Semver version (e.g., "1.0.0") |
| content required | string Prompt body text |
required | object Prompt metadata (id, namespace, scope, description) |
| input_schema | object Optional JSON Schema for prompt inputs |
{- "version": "1.0.0",
- "content": "You are a contract analysis assistant...",
- "meta": {
- "id": "contract-analysis",
- "namespace": "companion.task",
- "scope": "org",
- "description": "Analyzes legal contracts"
}, - "input_schema": {
- "type": "object",
- "properties": {
- "contract_text": {
- "type": "string"
}
}
}
}{- "prompt_uri": "string",
- "prompt_key": "string",
- "org_id": "string",
- "version": "string",
- "content": "string",
- "meta": { },
- "input_schema": { },
- "extends_uri": "string",
- "published_by": "string",
- "published_at": "2019-08-24T14:15:22Z",
- "status": "active"
}Rollback the active version of a prompt to a previously published version. The target version must exist and not be deprecated.
Requires prompt:rollback:{key} delegation scope.
| key required | string |
| target_version required | string Semver version to rollback to |
{- "target_version": "string"
}{- "prompt_uri": "string",
- "active_version": "string",
- "rolled_back_at": "2019-08-24T14:15:22Z"
}Mark a specific version of a prompt as deprecated. Deprecated versions cannot be rolled back to.
Requires prompt:deprecate:{key} delegation scope.
| key required | string |
| version required | string |
{- "prompt_uri": "string",
- "version": "string",
- "status": "deprecated",
- "deprecated_at": "2019-08-24T14:15:22Z"
}Returns performance statistics for a prompt over the last 7 days, including per-model breakdowns of latency, cost, token usage, and success rates. Recommends the best-performing model based on success rate with sufficient sample size.
| key required | string |
{- "prompt_key": "string",
- "window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}, - "stats": {
- "total_calls": 0,
- "avg_tokens": 0,
- "avg_cost_usd": 0,
- "avg_duration_ms": 0,
- "positive_signals": 0,
- "negative_signals": 0,
- "rephrases": 0,
- "corrections": 0
}, - "model_breakdown": [
- {
- "model_id": "string",
- "provider": "string",
- "call_count": 0,
- "avg_latency_ms": 0,
- "avg_cost_usd": 0,
- "avg_tokens": 0,
- "success_rate": 0
}
], - "recommended_model": "string"
}Returns model affinity data showing which models perform best on this specific prompt. Affinity scores are computed from success rate weighted by cost efficiency.
| key required | string |
| limit | integer Default: 20 |
{- "data": [
- {
- "prompt_key": "string",
- "model_id": "string",
- "provider": "string",
- "sample_size": 0,
- "stats": {
- "avg_latency_ms": 0,
- "avg_cost_usd": 0,
- "avg_tokens": 0,
- "success_rate": 0
}, - "affinity_score": 0
}
], - "pagination": {
- "has_more": true,
- "next_cursor": "eyJpZCI6ImdyYW50XzEyMyJ9",
- "total_count": 487
}
}Creates a resource entry in the resource graph. Policy resolution for (owner_did, kind) determines connector and storage backend.
| uri required | string |
| kind required | string |
| owner_did required | string |
| schema_id | string or null |
| metadata | object |
| provenance_ref | string or null |
{- "uri": "string",
- "kind": "string",
- "owner_did": "string",
- "schema_id": "string",
- "metadata": { },
- "provenance_ref": "string"
}{- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "uri": "string",
- "owner_did": "string",
- "controller_did": "string",
- "kind": "string",
- "schema_id": "string",
- "connector_id": "string",
- "metadata": { },
- "provenance_ref": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}Cursor-paginated list of active resources. Filter by kind, owner_did, connector_id.
| kind | string Filter by exact kind (e.g. core.email.message) |
| owner_did | string Filter by owner DID |
| connector_id | string Filter by connector ID |
| limit | integer [ 1 .. 100 ] Default: 20 |
| cursor | string Cursor from previous response next_cursor |
{- "data": [
- {
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "uri": "string",
- "owner_did": "string",
- "controller_did": "string",
- "kind": "string",
- "schema_id": "string",
- "connector_id": "string",
- "metadata": { },
- "provenance_ref": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
], - "has_more": true,
- "next_cursor": "string",
- "total_count": 0
}Retrieve a single resource by resource_id (UUID) or URI.
| id required | string Resource ID (UUID) or URI |
{- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "uri": "string",
- "owner_did": "string",
- "controller_did": "string",
- "kind": "string",
- "schema_id": "string",
- "connector_id": "string",
- "metadata": { },
- "provenance_ref": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}Update mutable fields (kind, schema_id, metadata, provenance_ref). owner_did is immutable.
| id required | string |
| kind | string |
| schema_id | string or null |
| metadata | object |
| provenance_ref | string or null |
{- "kind": "string",
- "schema_id": "string",
- "metadata": { },
- "provenance_ref": "string"
}{- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "uri": "string",
- "owner_did": "string",
- "controller_did": "string",
- "kind": "string",
- "schema_id": "string",
- "connector_id": "string",
- "metadata": { },
- "provenance_ref": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}Sets deleted_at; resource is excluded from list/get. Row retained for audit.
| id required | string |
{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}Resolves effective schema for org + kind (org_schema_prefs then latest canonical).
| org_did required | string |
| kind required | string |
{- "schema_id": "string",
- "authority_did": "string",
- "kind": "string",
- "version": 0,
- "definition": { },
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string"
}Register a new schema version for a kind. Authority rules enforced.
| kind required | string |
| definition required | object |
| created_by | string |
{- "kind": "string",
- "definition": { },
- "created_by": "string"
}{- "schema_id": "string",
- "authority_did": "string",
- "kind": "string",
- "version": 0,
- "definition": { },
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string"
}| kind | string |
| authority_did | string |
| limit | integer [ 1 .. 100 ] Default: 20 |
| cursor | string |
{- "data": [
- {
- "schema_id": "string",
- "authority_did": "string",
- "kind": "string",
- "version": 0,
- "definition": { },
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string"
}
], - "has_more": true,
- "next_cursor": "string"
}{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}Returns schema preferences for an org (kind_pattern → preferred_schema_id).
| org_did required | string |
| limit | integer [ 1 .. 100 ] Default: 20 |
| cursor | string |
{- "data": [
- {
- "org_did": "string",
- "kind_pattern": "string",
- "preferred_schema_id": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "has_more": true,
- "next_cursor": "string"
}| org_did required | string |
| kind_pattern required | string |
| preferred_schema_id required | string |
{- "org_did": "string",
- "kind_pattern": "string",
- "preferred_schema_id": "string"
}{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}| org_did required | string |
| kind_pattern required | string |
{- "title": "Validation Failed",
- "status": 400,
- "detail": "The request body contains invalid or missing fields",
- "instance": "/v1/capabilities/match",
- "errors": [
- {
- "field": "requiredCapabilities",
- "code": "REQUIRED_FIELD_MISSING",
- "message": "This field is required",
- "expected": "array of capability IDs",
- "received": "undefined"
}
], - "remediation": [
- {
- "step": 1,
- "description": "Include an Authorization header with a valid API token",
}
], - "request_id": "req_a7b3c9d2e1f4g5h6",
- "incident_id": "inc_xyz789"
}Returns display name, description, website, logo, brand tokens. Mutable data in org_profile (not org_passports).
| did required | string |
{- "org_did": "string",
- "display_name": "string",
- "description": "string",
- "website_url": "string",
- "logo_url": "string",
- "brand_tokens": { },
- "updated_by": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}| did required | string |
| display_name | string |
| description | string or null |
| website_url | string or null |
| logo_url | string or null |
| brand_tokens | object or null |
{- "display_name": "string",
- "description": "string",
- "website_url": "string",
- "logo_url": "string",
- "brand_tokens": { }
}{- "org_did": "string",
- "display_name": "string",
- "description": "string",
- "website_url": "string",
- "logo_url": "string",
- "brand_tokens": { },
- "updated_by": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Returns send_mode, from_display_name, from_email, reply_to_email, legal_footer.
| did required | string |
{- "org_did": "string",
- "send_mode": "transactional",
- "from_display_name": "string",
- "from_email": "string",
- "reply_to_email": "string",
- "legal_footer": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}