Skip to main content
POST
Create a scoped Agent Connection

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito).

Body

application/json
name
string
required
Required string length: 1 - 100
mode
enum<string>
required
Available options:
platform,
end_user
externalUserId
string

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$
tools
object
pricing
object
maxCreditsPerCall
string

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
maxCreditsPerLoop
string

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
expiresInSeconds
integer
Required range: 300 <= x <= 31536000

Response

Connection created; credential is returned once

success
any
required
connection
object
required