Create Agent

post/extensions/roboledger/{graph_id}/operations/create-agent

Create a counterparty record (customer, vendor, employee, etc.). The (source, external_id) pair is a dedup key — a second insert with the same pair returns 409. Use update-agent to patch fields.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`agent_type`required	string	Relationship category: 'customer' \| 'vendor' \| 'employee' \| 'owner' \| 'supplier' \| 'government' \| 'lender' \| 'self' \| 'other'.
`name`required	string	Display name shown in lists and on transactions.
`legal_name`optional	string	Full registered legal name (when different from `name`).
`tax_id`optional	string	Tax ID (EIN / SSN / VAT). Used for 1099 / withholding reporting.
`registration_number`optional	string	Registry-issued company number (e.g. state corp file number).
`duns`optional	string	Dun & Bradstreet DUNS number.
`lei`optional	string	Legal Entity Identifier (ISO 17442).
`email`optional	string
`phone`optional	string
`address`optional	object	Free-form address object (e.g. {"line1": "...", "city": "...", "state": "...", "postal_code": "..."}).
`source`optional	string	Provenance: 'native' (created in-app), 'quickbooks' / 'xero' / 'plaid' (synced from integration). Drives reconciliation behavior. Default: `native`
`external_id`optional	string	Source system primary key — used to match on subsequent syncs.
`is_active`optional	boolean	Inactive agents stay in history but can't be picked for new txns. Default: `true`
`is_1099_recipient`optional	boolean	Marks a vendor as 1099-eligible. Drives year-end 1099 reporting. Default: `false`
`metadata`optional	object

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/create-agent" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "agent_type": "vendor",
  "is_1099_recipient": true,
  "name": "Acme Office Supplies",
  "tax_id": "12-3456789"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

LedgerAgentResponse

Command-specific result payload

LedgerAgentResponse fields

Field	Type	Description
`id`required	string
`agent_type`required	string
`name`required	string
`legal_name`optional	string
`tax_id`optional	string
`registration_number`optional	string
`duns`optional	string
`lei`optional	string
`email`optional	string
`phone`optional	string
`address`optional	object
`source`required	string
`external_id`optional	string
`is_active`required	boolean
`is_1099_recipient`required	boolean
`created_at`optional	string (date-time)
`updated_at`optional	string (date-time)
`created_by`optional	string

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation (null for legacy callers)

idempotentReplayoptional

boolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error