API Keys

Create API key

Create an API key. The secret is returned only once.

post/api-keys

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Request body

Response

Successful Response

Changes

Changed in 7 of the 28 revisions of this API.3117

    • deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

    • header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • the scopes request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create

      request-property-default-value-changed

    • added the new wallets.balance enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • the scopes request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create

      request-property-default-value-changed

    • added the new wallets.deposit enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • added the new wallets.transfer enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • added the new optional request property data/attributes/tags

      new-optional-request-property

    • added the required property data/attributes/tags to the response with the 201 status

      response-required-property-added

  • 089aed4017a823See the full diff
    • removed the enum value direct_payments.create of the request property data/attributes/scopes/items/

      request-property-enum-value-removed

    • removed the enum value direct_payments.read of the request property data/attributes/scopes/items/

      request-property-enum-value-removed

    • the scopes request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct_payments.create direct_payments.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create

      request-property-default-value-changed

    • added the new direct.create enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • added the new direct.read enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • the scopes request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct_payments.create direct_payments.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create

      request-property-default-value-changed

    • added the new direct_payments.create enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • added the new direct_payments.read enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • added the new external_parties.create enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

    • added the new external_parties.read enum value to the request property data/attributes/scopes/items/

      request-property-enum-value-added

  • 270e233e401c11See the full diff
    • the data/attributes/name request property's maxLength was decreased to 32

      request-property-max-length-decreased

    • added the new UNKNOWN enum value to the data/attributes/status response property for the response status 201

      response-property-enum-value-added