Skip to content
Changelog

Report a bug

Skyfire integration: operations for AI agents

Skyfire connects to Type.com as an integration. This page lists the 41 operations documented for Claude and Codex in Type.com: 19 read, 15 write, 7 destructive.

About Skyfire

Skyfire enables AI agents to autonomously transact and pay for services, creating a seamless payment infrastructure for AI applications.

Categories: Developer Tools & IT, Commerce & Payments

How to connect Skyfire to Type.com

Access
Organization connection: one shared account for the workspace.
MCP
This integration is not available through Type’s MCP server. It remains available in Type.

To add the connection, follow the steps in Space connections.

Documented operations

41 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

41 operations listed.

  • Read

    Get Agent API Keys

    As an Organization Admin, list the API keys of an agent belonging to a user in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The agent is resolved through the ownership chain organization → user → agent, all scoped to your own organization. A user or agent that does not exist, belongs to another organization, or is not owned by the given user returns 404. Both active and inactive keys are returned, oldest first, to support rotation and cleanup. Key material is never returned. Keys are identified by their id and the last four characters of the key. Results are ordered by creation time ascending and paginated by cursor. When more results exist, the response includes a nextPageCursor (the id of the last key on the page) and carries a Link header pointing at the next page: Pass that value back as pageCursor to fetch the following page. When nextPageCursor is absent, you have reached the last page. pageSize defaults to 100 and may not exceed 1000. A pageCursor that was not returned by a previous page of the same listing returns 400.

    GET /api/v1/organizations/users/{userId}/agents/{agentId}/api-keys

  • Read

    Get Agent Group Agents

    As an Organization Admin, list the members of one of your organization's agent groups, one entry per enrolled user. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The group is resolved within your own organization; a group that does not exist or belongs to another organization returns 404. By default only currently enrolled users are returned. Pass includeUnenrolled=true to also return users who have been unenrolled. Their entries have enrolled: false and an unenrolledAt timestamp, and their deactivated instance's agentId is still listed, so its wallet stays reachable for fund recovery. agentActive is the instance's own flag, which is false once the user is unenrolled. status says whether the instance can transact right now: | status | Meaning | | ---------------- | ------------------------------------------------------------------------- | | active | The instance is active and the group is active. | | inactive | The instance is deactivated, which for a group instance means unenrolled. | | group_inactive | The instance is active but the group is deactivated, so it cannot mint. | Members are ordered by enrollment time ascending and paginated by cursor. The response body is a plain array. When more results exist, the response carries a Link header pointing at the next page: Take the pageCursor value from that URL and pass it back to fetch the following page. When no Link header is present, you have reached the last page. pageSize defaults to 100 and may not exceed 1000. A pageCursor that was not returned by a previous page of the same listing returns 400.

    GET /api/v1/agent-groups/{agentGroupId}/agents

  • Read

    Get Agent Group

    As an Organization Admin, fetch one of your organization's agent groups by id. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The group is resolved within your own organization. A group that does not exist or belongs to another organization returns 404. Inactive groups are returned; check active to tell them apart.

    GET /api/v1/agent-groups/{agentGroupId}

  • Read

    Get Agent Groups

    As an Organization Admin, list the agent groups in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. Only active groups are returned by default. Pass includeInactive=true to also return deactivated groups, which keep their members and can be reactivated with Update Agent Group (https://docs.skyfire.xyz/reference/update-agent-group). Results are ordered by creation time ascending and paginated by cursor. The response body is a plain array of groups. When more results exist, the response carries a Link header pointing at the next page: Take the pageCursor value from that URL and pass it back to fetch the following page. When no Link header is present, you have reached the last page. pageSize defaults to 100 and may not exceed 1000. A pageCursor that was not returned by a previous page of the same listing returns 400.

    GET /api/v1/agent-groups

  • Read

    Get Agent's Services - All

    Get all of the seller agent's services.

    GET /api/v1/agents/seller-services

  • Read

    Get Agent's Service

    Get a particular service belonging to the seller agent.

    GET /api/v1/agents/seller-services/{sellerServiceId}

  • Read

    Get Agent's Source IP Addresses

    Get the source IP addresses configured for the agent.

    GET /api/v1/agents/source-ips

  • Read

    Get Agent's Wallet Balance

    Get the wallet balance of the agent.

    GET /api/v1/agents/balance

  • Read

    Get All Service Tags

    Get all of the tags that services can be searched by.

    GET /api/v1/directory/tags

  • Read

    Get All Services

    Get all of the approved and active services.

    GET /api/v1/directory/services

  • Read

    Get Organization User Agents

    As an Organization Admin, list an organization user's agentswith their enrolled cards. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user must belong to your organization and be active: an unknown user returns 404 and a deactivated user returns 400. Every agent the user holds, active or not, ordered by creation time: their ungrouped buyer, their seller agents, and their instance of each agent group they are or were enrolled in. The response is a plain array and is not paginated. Pass agentGroupId to return only the user's instance of that group, which is a zero- or one-element array. | Field | Meaning | | -------------- | ----------------------------------------------------------------------------------------------------------------- | | agentGroupId | The group this agent is an instance of, or null for an ungrouped agent. Stays set after the user is unenrolled. | | active | The agent's own flag. false after deactivation or unenrollment. | | status | active, inactive, or group_inactive. The last means the agent is active but its group is deactivated. | Ungrouped agents are changed with Update Organization User Agent (https://docs.skyfire.xyz/reference/update-organization-user-agent). Grouped agents are changed through their group. cards lists the agent's active Visa and Mastercard enrollments, oldest first, each with its id, network, and last four digits, and whether it is suspended. Seller agents and agents with no cards return an empty array. preferredCardId names the card used by default, or null when none is set or the preferred card is no longer enrolled.

    GET /api/v1/organizations/users/{userId}/agents

  • Read

    Get Organization User by Email

    As an Organization Admin, fetch a single user in your organization by their exact email address. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The match is exact and case-insensitive — Ada@Example.com and ada@example.com resolve to the same user; substring matching is not supported on this endpoint (use the filter parameter on Get Organization Users (https://docs.skyfire.xyz/reference/get-organization-users) for substring search). The email is a path segment, so it must be URL-encoded: ada%40example.com. Only users in your own organization can be fetched. The organization is derived from the API key. An email that does not exist and an email that belongs to another organization's user return the same 404, so the response never reveals whether an address is registered elsewhere. Inactive users are returned as well (isActive: false), so admins can inspect them. The user is returned with the agents they own and, for each agent, its accounts. The response body is identical in shape to Get Organization User by ID (https://docs.skyfire.xyz/reference/get-organization-user-by-id).

    GET /api/v1/organizations/users/email/{email}

  • Read

    Get Organization User by ID

    As an Organization Admin, fetch a single user in your organization by their user ID. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. Only users in your own organization can be fetched. The organization is derived from the API key. A user that does not exist and a user that belongs to another organization return the same 404, so the response never reveals whether a given ID exists elsewhere. Inactive users are returned as well (isActive: false), so admins can inspect them. The user is returned with the agents they own and, for each agent, its accounts.

    GET /api/v1/organizations/users/{userId}

  • Read

    Get Organization Users

    As an Organization Admin, list the users in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401. Only users in your own organization are returned. The organization is derived from the API key, so there is no organization parameter. Each user is returned with the agents they own and, for each agent, its accounts. Results are ordered by email ascending and paginated by cursor, not by offset. When more results exist, the response includes a nextPageCursor and the response carries a Link header pointing at the next page: Pass that value back as pageCursor to fetch the following page. When nextPageCursor is absent, you have reached the last page. pageSize defaults to 100 and may not exceed 1000. A value below 1 or above 1000 returns 400. filter is a JSON object encoded as a string in the query, so it must be URL-encoded. For example, filter={"active":true} is sent as: | Field | Type | Behaviour | | --------------- | ------- | ---------------------------------------------------------------------------------------------------- | | id | string | Exact match on user ID. A value that is not a valid UUID returns an empty list rather than an error. | | email | string | Substring match on email address. | | identifier | string | Substring match on email, unless the value is a valid UUID, in which case it matches on user ID. | | active | boolean | Filter by whether the user is active. | | admin | boolean | true returns Organization Admins; false returns standard members. | | orgMemberRole | string | Exact match on organization role. | Filters combine with AND. filter must be valid JSON.

    GET /api/v1/organizations/users

  • Read

    Get Service

    Get a single service's details by its ID.

    GET /api/v1/directory/services/{serviceId}

  • Read

    Get Services by Agent

    Get all of the services belonging to a single agent.

    GET /api/v1/directory/agents/{agentId}/services

  • Read

    Get Services by Tags

    Get all of the services that match the given tags.

    GET /api/v1/directory/services/search

  • Read

    Get Token Charges

    Get the charges on a pay or kya-pay token as a buyer or seller agent.

    GET /api/v1/tokens/{tokenId}/charges

  • Read

    Introspect Token

    Check whether a token is currently usable and get the remaining balance as a buyer or seller agent. This endpoint always returns 200, even when the token is invalid, check isValid in the body. A 401 response means the API key itself was rejected, not the token.

    POST /api/v1/tokens/introspect

  • Write

    Activate Agent API Key

    As an Organization Admin, re-enable a previously deactivated API key of an agent belonging to a user in your organization. Activating an already-active key is a no-op. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The key is resolved through the ownership chain organization → user → agent → API key, all scoped to your own organization. Any link in the chain that does not exist, belongs to another organization, or is mismatched (for example, a valid key ID under a different agent) returns 404. Activation takes effect immediately; the key authenticates on the next request. Activating a key that is already active is a no-op and still returns 204.

    PATCH /api/v1/organizations/users/{userId}/agents/{agentId}/api-keys/{apiKeyId}/activate

  • Write

    Activate Agent's Service

    Activate a seller service belonging to an agent. Only approved seller services can be activated.

    POST /api/v1/agents/seller-services/{sellerServiceId}/activate

  • Write

    Create Agent API Key

    As an Organization Admin, create a new API key for an agent belonging to a user in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The agent is resolved through the ownership chain organization → user → agent, all scoped to your own organization. A user or agent that does not exist, belongs to another organization, or is not owned by the given user returns 404. The agent must be active. An inactive agent also returns 404. > The raw key is returned only in this response and cannot be retrieved again. Store it securely on receipt. Afterwards the key is identified only by its id and lastFour. The new key is active immediately. An agent can hold multiple active keys at once. Use the optional notes field to label keys for rotation tracking.

    POST /api/v1/organizations/users/{userId}/agents/{agentId}/api-keys

  • Write

    Create Agent Group

    As an Organization Admin, create an agent group in your organization. As an Organization Admin, create an agent group: an agent identity owned by your organization, such as ShoppingBot, that you instantiate once per enrolled user. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The group is created in your organization, derived from the API key; there is no orgId field in the request body. A new group is active immediately and has no members. Enroll users with Enroll User in Agent Group (https://docs.skyfire.xyz/reference/enroll-user-agent-group-user), or create them straight into the group with Create Organization User (create-organization-user.md). name must be printable ASCII (letters, digits, space, and punctuation), 1 to 100 characters, with at least one non-space character. Other characters return 422. Names are compared case-insensitively with whitespace trimmed and collapsed: ShoppingBot, shoppingbot, and Shopping Bot are treated as the same name. The stored name keeps the casing you send. A group name must be unique among your organization's groups, and may not match the name of an active, ungrouped agent belonging to any user in your organization. Either collision returns 409. Each enrolled user's instance of the group is a buyer agent whose display name is the group's name, so a seller sees ShoppingBot in the token's aid.name regardless of which user is acting.

    POST /api/v1/agent-groups

  • Write

    Create Agent's Service

    Create a seller service that belongs to an agent.

    POST /api/v1/agents/seller-services

  • Write

    Create Organization User Buyer Agent

    As an Organization Admin, create an ungrouped buyer agent for an organization user, with a wallet and one API key. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user must belong to your organization and be active: an unknown user returns 404 and a deactivated user returns 400. A user holds at most one ungrouped buyer agent, and a deactivated one still counts. Most users already have one, created as Buyer 1 by Create Organization User (https://docs.skyfire.xyz/reference/create-organization-user). This endpoint is for users who were created directly into an agent group and so have no buyer of their own, or whose buyer was never created. If the user already has an ungrouped buyer, the call returns 409; reactivate or rename the existing agent with Update Organization User Agent (https://docs.skyfire.xyz/reference/update-organization-user-agent) instead. Agents that belong to agent groups do not count toward this limit. A user may be enrolled in any number of groups alongside their own buyer. displayName must be printable ASCII, 1 to 100 characters, with at least one non-space character. Names are compared case-insensitively with whitespace trimmed and collapsed. The name must be free among the user's active agents, and may not match an active agent group in your organization. Either collision returns 409. All checks run before anything is provisioned, so a refused request creates nothing. > apiKey is returned only in this response and cannot be retrieved again. Store it securely before discarding the response. Further keys can be created with Create Agent API Key (https://docs.skyfire.xyz/reference/create-agent-api-key).

    POST /api/v1/organizations/users/{userId}/agents/buyer

  • Write

    Create Organization User Seller Agent

    As an Organization Admin, create a seller agent for a user in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user identified by userId must belong to your organization and must be active. A user from another organization is reported as 404, and a deactivated user returns 400. A single request creates: 1. A seller agent owned by the user, with the displayName you supply. 2. A wallet for that agent. 3. An API key for that agent, returned as apiKey. > apiKey is returned only in this response and cannot be retrieved again. Store it securely before discarding the response. Each organization user can own at most one seller agent. Calling this endpoint for a user who already has one returns 400, and the existing agent is left untouched. To give an organization several seller agents, create a separate user for each.

    POST /api/v1/organizations/users/{userId}/agents/seller

  • Write

    Create Organization User Session Token

    As an Organization Admin, create a short-lived session token for a user in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user identified by userId must belong to your organization. A user that does not exist, or that belongs to another organization, is reported as 404. Your organization must have a representative user, and the target user must have a Skyfire login identity. If either is missing, the call returns 400. The response body is the session token itself, returned as a bare JSON string rather than an object (Content-Type: application/json). The body includes the surrounding double quotes, so parse it as JSON, or strip the quotes if you read it as plain text. The session token expires 5 minutes after it is created. The lifetime is fixed and cannot be changed in the request. Create the token immediately before you need it, and request a new one when it expires. > Treat the session token as a credential. It acts as the user whose userId you supplied. Do not log it or share it. userId is required and must be a valid UUID. Calling this endpoint again does not revoke earlier tokens. Each one stays valid until its own 5 minutes are up.

    POST /api/v1/auth/skyfire-session-token

  • Write

    Create Organization User

    As an Organization Admin, create a new user in your organization, with a buyer agent, wallet, and API key. Optionally enroll the user in an agent group, making the buyer agent their instance of it. A duplicate email is rejected with 409 before anything is provisioned. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The new user is always created in your organization. It is derived from the API key, and there is no orgId field in the request body. | role | Result | | -------- | ---------------------------------------------------------------------------------------- | | MEMBER | Standard organization user. | | ADMIN | Organization Admin. Additionally receives a user API key, returned once as userApiKey. | A single request creates: 1. The organization user. 2. A buyer agent with a wallet. Without agentGroupId it is the user's own agent, named Buyer 1. With agentGroupId it is the user's instance of that agent group, named after the group. 3. An API key for that buyer agent, returned as buyerAgent.apiKey. 4. If role is ADMIN, an Organization Admin User API key, returned as userApiKey. If any step fails, the whole transaction is rolled back and no user is created. > buyerAgent.apiKey and userApiKey are returned only in this response > > and cannot be retrieved again. Store them securely before discarding the > response. For role: "MEMBER", userApiKey is omitted from the response body entirely. It is not returned as null. Pass agentGroupId to enroll the new user in one of your organization's agent groups as part of creation. The buyer agent is then the user's instance of the group: its display name is the group's name, and tokens it mints carry that name as aid.name. The user gets no Buyer 1 agent; one can be added later with Create Organization User Buyer Agent (create-organization-user-buyer-agent.md), and the user can be enrolled in further groups with Enroll User in Agent Group (enroll-agent-group-user.md). The group must belong to your organization (404 otherwise) and be active (400 if deactivated). Both checks run before anything is provisioned. An email is unique within your organization. If an active or deactivated user with the same email already exists, the request is rejected with 409 before anything is provisioned. Recover the existing user with Get Organization User by Email (get-organization-user-by-email.md), which returns their id and agents; the original API keys cannot be retrieved, but new ones can be created with Create Agent API Key (create-agent-api-key.md).

    POST /api/v1/organizations/users

  • Write

    Create Token

    Create a kya, pay, or kya-pay token as a buyer agent. Only buyer agents can create tokens; a seller agent key is rejected. Tokens can be created for either an onboarded seller or an external seller. Provide exactly one of sellerServiceId or sellerDomainOrUrl. Sending both, or neither, is rejected. Use this when the seller is onboarded to Skyfire and has a Seller Service listed in the Skyfire Directory. Provide sellerServiceId Uses your standard Skyfire Buyer Agent API key Supports kya, pay, and kya-pay tokens, subject to the token types the seller service accepts pay and kya-pay tokens are funded from your stablecoin wallet tokenAmount accepts up to six decimal places and must meet the seller's minimum Default token expiration: 24 hours (or a shorter maximum configured by the seller) Use this when accessing a website, webpage, or API that is not onboarded to Skyfire. Provide sellerDomainOrUrl Available only to buyer agents that belong to a Skyfire Organization kya tokens need nothing else pay and kya-pay tokens must be funded from a Visa or Mastercard wallet: pass the card wallet's ID as accountId and the card details in additionalInfo. Stablecoin-funded payments to external sellers are not supported. Default token expiration: 5 minutes, or a maximum configured for that domain > External seller token creation is available only to Skyfire organizations. Standard Skyfire Buyer Agents cannot create tokens for external sellers.

    POST /api/v1/tokens

  • Write

    Enroll User in Agent Group

    As an Organization Admin, enroll an organization user in an agent group. As an Organization Admin, enroll an existing organization user in an agent group. This mints the user's instance of the group: a buyer agent named after the group, with a wallet and one API key. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. Both the group and the user must belong to your organization. An unknown group returns 404, an unknown user returns 404, and a deactivated user returns 400. On a first enrollment, a single request creates: 1. A buyer agent for the user, with displayName equal to the group's name. 2. A wallet for that agent. 3. An API key for that agent, returned as apiKey. The response is 201 Created. Tokens minted with this key carry the group's name as aid.name and the agent's id as aid.id. > apiKey is returned only in this response and cannot be retrieved again. Store it securely before discarding the response. Further keys for the instance can be created with Create Agent API Key (https://docs.skyfire.xyz/reference/create-agent-api-key). To create a brand-new user directly into a group, pass agentGroupId to Create Organization User (https://docs.skyfire.xyz/reference/create-organization-user) instead. PUT is safe to retry. If the user is already enrolled, the response is 200 OK with the existing enrollment and no apiKey. This holds even when the group has since been deactivated. New enrollment into a deactivated group returns 400. Reactivate the group with Update Agent Group (https://docs.skyfire.xyz/reference/update-agent-group) first. A user who was unenrolled and is enrolled again receives a fresh instance: a new agent, wallet, and key. The old instance stays deactivated, and its wallet remains reachable through Get Agent Group Agents (https://docs.skyfire.xyz/reference/get-agent-group-agents) with includeUnenrolled=true. If wallet provisioning fails, nothing is created and the error is returned. A retry is safe. In the rare case that two enrollments of the same user race, one wins and the other returns 200 with that enrollment, so a user never ends up with two instances of the same group.

    PUT /api/v1/agent-groups/{agentGroupId}/enrollments/{userId}

  • Write

    Set Agent's Source IP Addresses

    Set the source IP addresses for the agent.

    PUT /api/v1/agents/source-ips

  • Write

    Set Organization User Status as Active

    As an Organization Admin, reactivate a deactivated user in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user identified by userId must belong to your organization. A user from another organization, or one that does not exist, is reported as 404. On success the endpoint returns 204 No Content with an empty body. Reactivating a user restores their own access and the access of every agent they own. Activating a user who is already active succeeds and returns 204. > API key lookups are cached for up to 60 seconds, so access may take up to a minute to be restored after this call returns.

    PATCH /api/v1/organizations/users/{userId}/activate

  • Write

    Set Organization User Personal Data

    As an Organization Admin, set personal data for a user in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user identified by userId must belong to your organization and must be active. A user from another organization is reported as 404, and a deactivated user returns 400. On success the endpoint returns 204 No Content with an empty body. > Skyfire follows industry best practices to protect personal data. All data is encrypted in transit and at rest, and decrypted only inside a trusted execution environment when it's needed. Skyfire is a PCI-DSS Level 2 service provider.

    POST /api/v1/organizations/users/{userId}/personal-data

  • Write

    Update Agent's Service

    Update a seller service that belongs to the agent.

    PATCH /api/v1/agents/seller-services/{sellerServiceId}

  • Destructive

    Charge Token

    Charge a pay or kya-pay token as a seller agent or seller service. Use this API after delivering a service, tool, or resource to collect payment from a buyer-issued token. Before charging, seller services should validate tokens when requests are received and reject tokens that have already expired. Only pay and kya-pay tokens can be charged. kya tokens cannot be charged. To support long-running operations, Skyfire allows charges to be submitted for up to 24 hours after a token expires. This grace period applies only when the token was accepted and validated before expiration. Seller services should not accept expired tokens from buyers, but may complete charges after expiration for services that began while the token was still valid. For more information on pay token validation, see here (https://docs.skyfire.xyz/reference/verify-and-extract-data-from-tokens#pay-tokens-typ--payjwt). Charges are not settled immediately. Settlement may take up to 51 hours depending on token expiration and charging activity. For details, see Settlement of Payments (https://docs.skyfire.xyz/reference/settlement-of-payments).

    POST /api/v1/tokens/charge

  • Destructive

    Deactivate Agent API Key

    As an Organization Admin, disable an API key of an agent belonging to a user in your organization so it no longer authenticates. Keys are never deleted and can be re-enabled later. Deactivating an already-inactive key is a no-op. As an Organization Admin, disable an API key of an agent belonging to a user in your organization so it no longer authenticates. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The key is resolved through the ownership chain organization → user → agent → API key, all scoped to your own organization. Any link in the chain that does not exist, belongs to another organization, or is mismatched (for example, a valid key ID under a different agent) returns 404. Keys are never deleted — a deactivated key remains visible in Get Agent API Keys (https://docs.skyfire.xyz/reference/get-agent-api-keys) with active: false and can be re-enabled later with Activate Agent API Key (https://docs.skyfire.xyz/reference/activate-agent-api-key). Deactivating a key that is already inactive is a no-op and still returns 204. Deactivation is typically immediate. Because authentication results are cached, requests using the deactivated key may continue to succeed for a short window after this call returns; revocation is guaranteed everywhere once the authentication cache expires. For zero-downtime rotation, create the replacement key first, migrate your workload, and deactivate the old key last.

    PATCH /api/v1/organizations/users/{userId}/agents/{agentId}/api-keys/{apiKeyId}/deactivate

  • Destructive

    Deactivate Agent's Service

    Deactivate a seller service belonging to an agent.

    POST /api/v1/agents/seller-services/{sellerServiceId}/deactivate

  • Destructive

    Set Organization User Status as Inactive

    As an Organization Admin, deactivate a user in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user identified by userId must belong to your organization. A user from another organization, or one that does not exist, is reported as 404. On success the endpoint returns 204 No Content with an empty body. Deactivating a user revokes their own access and the access of every agent they own. Deactivating a user who is already inactive succeeds and returns 204. The organization's representative user cannot be deactivated, and the attempt returns 400. Assign the representative role to a different user first. > API key lookups are cached for up to 60 seconds, so access may persist for up to a minute after this call returns. Do not treat it as an immediate revocation for incident response.

    PATCH /api/v1/organizations/users/{userId}/deactivate

  • Destructive

    Unenroll User from Agent Group

    As an Organization Admin, remove a user from an agent group. Their instance of the group is deactivated and its cards are removed. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The group is resolved within your own organization; an unknown group returns 404. A user who has never been enrolled in the group returns 404. 1. The enrollment is closed and the instance agent is deactivated. Its API keys stop authenticating immediately. 2. Every card enrolled on the instance is removed at the card network. 3. The instance's wallet is kept, so any remaining balance stays reachable for recovery. Funds are never swept automatically. The response is 204 No Content. Unenrolling works whether or not the group is active. The deactivated instance keeps appearing in Get Agent Group Agents (https://docs.skyfire.xyz/reference/get-agent-group-agents) when includeUnenrolled=true, with enrolled: false and status: "inactive". It cannot be reactivated through the agent update endpoint; re-enrolling the user mints a fresh instance instead. DELETE is safe to repeat. The instance is deactivated before cards are removed, so a failure at the card network leaves the keys dead rather than the agent live. Calling again for an already unenrolled user finishes any card removal that did not complete and returns 204.

    DELETE /api/v1/agent-groups/{agentGroupId}/enrollments/{userId}

  • Destructive

    Update Agent Group

    As an Organization Admin, rename, describe, deactivate, or reactivate an agent group in your organization. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. All fields are optional; only the fields you send are changed. The group is resolved within your own organization; a group that does not exist or belongs to another organization returns 404. Renaming a group renames every active member agent in the same transaction, so each enrolled user's instance keeps presenting the group's name. Tokens minted after a rename carry the new name as aid.name. API keys cache the agent they belong to for up to 60 seconds, so a token minted within a minute of the rename may still show the old name. The new name follows the rules in Create Agent Group (https://docs.skyfire.xyz/reference/create-agent-group): printable ASCII, 1 to 100 characters, unique among your groups after folding. While the group is active it also may not match an active ungrouped agent's name in your organization. A collision returns 409. An inactive group may share a name with an ungrouped agent, since it is not presenting that name; reactivating it then requires the name to be free again. active: false pauses the group. Member agents are not modified: they stay active and keep their keys, cards, and wallets, but no member can obtain a token (400), and no user can be enrolled (400) until the group is reactivated. Member agents report status: "group_inactive" in agent listings while the group is paused. active: true reactivates the group, re-checking its name against the organization's namespace. There is no delete; a group you no longer use stays deactivated.

    PATCH /api/v1/agent-groups/{agentGroupId}

  • Destructive

    Update Organization User Agent

    As an Organization Admin, rename, deactivate, or reactivate one of your organization users' ungrouped agents. Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401. The user must belong to your organization and be active: an unknown user returns 404 and a deactivated user returns 400. The agent must belong to that user; otherwise 404. All body fields are optional and only the fields you send are changed. The response is 204 No Content. An agent that is a user's instance of an agent group cannot be changed here, and returns 400. Rename it by renaming the group with Update Agent Group (https://docs.skyfire.xyz/reference/update-agent-group); deactivate it with Unenroll User from Agent Group (https://docs.skyfire.xyz/reference/unenroll-user-agent-group); reactivate by enrolling again. This also applies to an instance whose user has already been unenrolled. displayName must be printable ASCII, 1 to 100 characters, with at least one non-space character. Names are compared case-insensitively with whitespace trimmed and collapsed. The new name must be free among the user's active agents, and may not match an active agent group in your organization. Either collision returns 409. Tokens minted afterwards carry the new name as aid.name; keys cache their agent for up to 60 seconds, so a token minted within a minute of the rename may still show the old name. active: false deactivates the agent: its API keys stop authenticating and every card enrolled on it is removed at the card network. The wallet is kept, so any remaining balance stays reachable. Repeating a deactivation is safe and finishes any card removal that failed. active: true reactivates the agent. Its existing API keys work again. Cards are not restored and must be enrolled again. Because a deactivated agent's name is not reserved, reactivation re-checks the name and returns 409 if another active agent or group has since taken it. A deactivated buyer agent still counts as the user's one ungrouped buyer, so reactivate it rather than creating another.

    PATCH /api/v1/organizations/users/{userId}/agents/{agentId}

See How connections work for access and permissions, or browse all integrations.

Reference date: October 28, 2026. Skyfire API docs.