API Reference
Reference for API endpoints available in ActionKit.
Authorization
Base URL
For on-premise instances
For on-premise instances
Authentication
To authenticate to ActionKit API, present a Bearer token with the Paragon User Token (a JWT):
This is the same token that you used to call .authenticate
with the Paragon SDK. See examples in Installing the SDK.
Endpoints
List Actions
Every Connected User will have access to different Actions, depending on what Integrations you have enabled in your project and what accounts they have connected. You can list available Actions using the GET /actions
endpoint.
The schema returned by Actions may be user-specific. For example, if the user has custom fields defined for Salesforce Opportunities, they will appear in their version of the SALESFORCE_CREATE_RECORD_OPPORTUNITY
Action schema.
URL
Parameters
Key | Description | Default |
---|---|---|
format | The response format for available actions. Defaults to json_schema for tool-calling agent use cases. Learn more about available formats. | json_schema |
limit_to_available | If true , only available_actions will be returned. Otherwise, all_actions will include all Actions from Integrations in your project, regardless of the accounts your user has connected. | true |
reload_fields | If true , forcibly reload any custom fields that belong to the schema for included Actions. This may result in additional latency added to your request. By default, Paragon will cache your user’s fields and refresh them periodically. Fields have a TTL of 8 hours, and reload_fields will immediately invalidate any cached fields. | false |
integrations | Filter by specific integrations that the user has connected. By default, all integrations are returned. Example: salesforce,hubspot | |
categories | Filter by specific integration categories, based on integrations the user has connected. By default, all integrations from all categories are returned. Example: crm,project_management |
Output
Key | Description |
---|---|
actions | A map of integrations with a list of Action definitions, in the selected format. |
errors | An array of errors, if there were any problems loading Action definitions for some integrations. |
Example response
Example response
Run Action
To run an Action, call the Run Actions endpoint with the required parameters.
URL
Request body
Example response
Example response
Note: Responses will vary by integration provider. Paragon returns the API response of the last request that was used to run this Action.
Example Error
Example Error