Skip to main content
POST
Call tool for integration

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Headers

x-veryfront-expected-project-id
string<uuid>

Optional immutable project UUID precondition, compared case-insensitively after project resolution and authorization. It never selects a project. A mismatch fails with validation-failed before tool discovery or execution, including for project-bound callers. Send exactly one value.

Example:

"11111111-1111-4111-8111-111111111111"

x-veryfront-project-slug
string

Required for callers without a project-bound context. The slug is resolved and authorized before discovery or execution. A project-bound context takes precedence and ignores this header, including conflicting values.

Example:

"example-project"

Path Parameters

integration
string
required

Integration name from the catalog

Minimum string length: 1
Pattern: ^[^\s/]+$
Example:

"github"

tool
string
required

Tool ID within the integration.

Minimum string length: 1
Pattern: ^[^\s/]+$
Example:

"list-repos"

Body

application/json
arguments
object

Tool arguments. Unknown top-level body fields are rejected, so provider arguments must be sent here.

run_id
string

Agent run ID for validating run-declared integration tools

agent_id
string

Agent ID for validating run-declared integration tools

connection_id
string<uuid>

Optional exact connected account to use for this call

expected_connection_generation_id
string<uuid>

Require this observed generation of the selected connection. Requires connection_id; stale selections fail before credential or provider effects.

Response

Tool execution result

content
object[]
structuredContent
object
isError
boolean
_meta
object