Prepare a revision of a draft

POST/api/public/v1/aip/drafts/{public_id}/prepare beta

Starts the draft's preparation for revision: ground what has no grounding, run every case, pack the draft and replay it. A request for a revision whose job is running or ready returns that job. 409 DRAFT_REVISION_STALE when the draft changed since that revision; 409 GROUNDING_IN_FLIGHT while one of its intent policies is being grounded.

cURL

curl --fail-with-body -X POST 'https://app.openlatch.ai/api/public/v1/aip/drafts/<draft_public_id>/prepare' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"revision":<revision>}'

Python

import json
import os
import urllib.request

body = '{"revision":<revision>}'
request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/aip/drafts/<draft_public_id>/prepare',
    method='POST',
    data=body.encode(),
    headers={
        'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'],
        'Content-Type': 'application/json',
    },
)
with urllib.request.urlopen(request) as response:
    text = response.read().decode()
    print(json.dumps(json.loads(text), indent=2) if text else response.status)

Bash

#!/usr/bin/env bash
set -euo pipefail

curl -sS --fail-with-body -X POST 'https://app.openlatch.ai/api/public/v1/aip/drafts/<draft_public_id>/prepare' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"revision":<revision>}' | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
$body = '{"revision":<revision>}'
Invoke-RestMethod -Method POST -Uri 'https://app.openlatch.ai/api/public/v1/aip/drafts/<draft_public_id>/prepare' -Headers $headers -ContentType 'application/json; charset=utf-8' -Body $body | ConvertTo-Json -Depth 20

Autorización

Rol en la organización	Este punto de conexión
owner	Permitido
admin	Permitido
editor	Permitido
viewer	No permitido

Una clave tiene el rol que su propietario ocupa en la organización. Consulte Autenticación.

Ámbito de la clave de API: aip:write

Parámetros de ruta

Parámetro	Tipo	Descripción
public_id	string	Obligatorio.

Parámetros de encabezado

Parámetro	Tipo	Descripción
Idempotency-Key	string or null	Optional. Makes this request safe to retry. Depending on the request, the same key with the same request either joins the job the first one queued (409 JOB_ALREADY_EXISTS, the job id in details) or replays the first answer (Idempotent-Replayed: true; 409 IDEMPOTENCY_IN_PROGRESS while it runs). The same key with another request is 422 IDEMPOTENCY_KEY_REUSED.

Cuerpo de la solicitud

Campo	Tipo	Descripción
revision	integer	Obligatorio.

Respuesta

• 202 Accepted — la llamada se completó correctamente.
• 400 Bad Request — BAD_REQUEST
• 401 Unauthorized — UNAUTHORIZED
• 402 Payment Required — license_expired
• 403 Forbidden — FEATURE_DISABLED, FORBIDDEN, INSUFFICIENT_SCOPE
• 404 Not Found — NOT_FOUND
• 409 Conflict — DRAFT_REVISION_STALE, GROUNDING_IN_FLIGHT, JOB_ALREADY_EXISTS
• 422 Unprocessable Content — IDEMPOTENCY_KEY_REUSED, INVALID_ID, VALIDATION_ERROR
• 429 Too Many Requests — TOO_MANY_REQUESTS
• 500 Internal Server Error — INTERNAL_SERVER_ERROR, tenant_isolation_violation
• 503 Service Unavailable — FEATURE_STATE_UNAVAILABLE, SERVICE_UNAVAILABLE

Campos de la respuesta

Campo	Tipo	Descripción
data	object	Obligatorio. `202 for a job-starting operation: poll GET /aip/jobs/{job_id}`.
data.job_id	string	Obligatorio.

Ejemplo de respuesta

{
  "data": {
    "job_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10"
  }
}

Véase también

• GET Leer los metadatos de redacción de AIP
• POST Start a draft from a source or a preset
• DELETE Descartar un borrador