Apply an organization import (legacy route)

POST/api/companies/import
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 4 · History

Apply an organization import (legacy route).

Accepts either the inline JSON body (application/json) or the raw organization package uploaded as a compressed zip (multipart/form-data with a package file field plus a JSON meta field, or a bare application/zip body with the meta JSON in the meta query parameter); the zip is unzipped server-side into the same import bundle. Callers can opt into asynchronous processing: trusted Cloud tenants set the x-veyra-cloud-async-import: 1 header (browsers cannot — the Cloud harness proxy strips inbound x-veyra-cloud-* headers), while board sessions use the proxy-safe ?async=1 query parameter. Either way the server responds 202 with a job id and status URL instead of holding the connection open for the whole import. While a board actor already has an async job running, a resubmit returns 409 carrying the running job's id and status URL. Jobs are held in memory and are lost on restart.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Query parameters

asyncstringOptionalone of: "1"

Request body

application/json · required

sourceobjectRequired
includeobjectOptional
include.companybooleanOptional
include.agentsbooleanOptional
include.projectsbooleanOptional
include.issuesbooleanOptional
include.skillsbooleanOptional
targetobjectRequired
agentsstring | array<string>Optional
collisionStrategystringOptionalone of: "rename", "skip", "replace"
nameOverridesobject<string, string>Optional
selectedFilesarray<string>Optional
adapterOverridesobject<string, object>Optional
secretValuesobject<string, string>Optional
pauseAutomationsbooleanOptional

Responses

200SuccessThe request worked; the body holds the result.
202Async import job acceptedAccepted; the work continues in the background.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
409An async import job is already running for this actorThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Organizations