Skip to navigation

Create a trace import

Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with import. A one-time import returns HTTP 202 with import, run, and task. Example request: {"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}.

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Path parameters

agent_uuidstringRequired
Agent UUID

Request

Import request
connection_uuidstringOptional
ConnectionUUID identifies the project trace connection.
learn_frombooleanOptional
LearnFrom controls whether imported evidence can support Skills.
mappingobjectOptional

Mapping defines how source traces become Traces. Example: {“task_family”:{“source”:“fixed”,“value”:“support”}}.

namestringOptional
Name is the import display name.
on_source_changeenumOptional
OnSourceChange defines how changed source traces are handled.
Allowed values:
provider_project_idstringOptional
ProviderProjectID is the source provider project identifier.
require_reviewbooleanOptional
RequireReview requires review for candidates backed by this import.
scheduleobjectOptional

Schedule enables recurring imports when supplied. Example: {“interval_hours”:4,“start_from”:“now”,“settle_minutes”:5,“max_open_hours”:24}.

selectionobjectOptional

Selection defines the traces to import. Example: {“trace_ids”:[“trace_123”]}.

Response

Created
importobjectOptional

Import is the created import resource. Example: {“uuid”:“332c28e1-e6a7-4bca-97b2-ef1ec82c65fa”}.

runobjectOptional

Run is the pending one-time run. The field is absent for a scheduled import. Example: {“uuid”:“ea7e2724-9bfd-4ca1-aa5c-40a1dd72a688”,“status”:“pending”}.

taskobjectOptional

Task is the pending Task that will process the run. The field is absent for a scheduled import. Example: {“uuid”:“3124c01a-8f49-4bfd-9758-6ce491a377c1”,“status”:“pending”}.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error