La referencia de la API se publica en inglés.

Preview organization import

POST/api/companies/{companyId}/imports/preview
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Preview organization import.

Safe import into this organization only: target must be { mode: "existing_company", companyId } for the route organization or a new organization, and collisionStrategy may be "rename" or "skip" ("replace" is rejected, so an existing agent is never overwritten). nameOverrides maps an incoming agent, project or task slug to the name it should get. Preview never changes the organization; apply creates or reuses resources and returns them.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

sourceobjectObligatorio
includeobjectOpcional
include.companybooleanOpcional
include.agentsbooleanOpcional
include.projectsbooleanOpcional
include.issuesbooleanOpcional
include.skillsbooleanOpcional
targetobjectObligatorio
agentsstring | array<string>Opcional
collisionStrategystringOpcionalone of: "rename", "skip", "replace"
nameOverridesobject<string, string>Opcional
selectedFilesarray<string>Opcional

Respuestas

200SuccessThe request worked; the body holds the result.
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.
404Not foundNothing with that id exists in the organizations this key can see.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Organizations