Skip to main content

Referencia de la API de HappyOyster-Directing-Send Process Instruction

Envía una única instrucción de texto a un Viaje en modo estándar para impulsar la generación de fotogramas subsiguientes. Solo se admite creationModel=simple; un Viaje scriptlist debe usar la actualización completa del guion.

Ámbito

Envía una única instrucción de texto a un Viaje en modo estándar (creationModel=simple) para impulsar la generación de fotogramas subsiguientes. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: La clave de API principal no es obligatoria; pueden invocarla tanto la clave principal como una temporal. Para saber cómo obtenerlas, consulte Obtener credenciales de autenticación.
  • Requisitos previos: El creationModel del Viaje debe ser simple, y debe estar en un estado capaz de recibir instrucciones. Confírmelo mediante Consultar estado del viaje.
  • Solicitante: Puede invocarla su servidor o su cliente.

Solicitud HTTP

  • Singapore
  • EE. UU. (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/instructReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Enviar instrucción de proceso
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "A giant robot dinosaur suddenly appears",
    "clientRequestId": "instruction_20260909_001",
    "userAgent": "your-client/1.2.0"
}'
Content-Typestring(Requerido)Tipo de contenido de la solicitud. Este parámetro debe establecerse en application/json.
Authorization string (Requerido)Autenticación mediante clave de API. No se requiere la clave de API principal; pueden invocarla tanto la clave principal como una temporal.
  • Clave de API principal: comienza con sk-, por ejemplo, sk-xxx.
  • Clave de API temporal: comienza con st-, por ejemplo, st-xxx.
Cuerpo de la solicitud
encryptedTravelId string (Obligatorio)El ID de Viaje cifrado de Dirección a controlar; creationModel debe ser simple. Devuelto por Entrar al viaje.
content string (Obligatorio)La instrucción de proceso de texto. No vacía, hasta 2000 caracteres; devuelve 400000 cuando está vacía o supera los 2000 caracteres.
clientRequestId string (Opcional)Clave de idempotencia para reintentos de instrucciones. Reutilice el mismo valor al reintentar la misma instrucción para evitar facturación duplicada. Formato recomendado [A-Za-z0-9_-]{1,32}.
  • Si se omite o tiene un formato incorrecto, no devuelve un error de parámetro: el servidor recurre al request_id de la puerta de enlace y utiliza una clave de idempotencia aleatoria cuando este tampoco está disponible
  • Este campo se utiliza únicamente para la deduplicación de facturación; no garantiza que el procesamiento de la instrucción en sí se ejecute exactamente una vez
userAgent string (Opcional)Identificador de versión del SDK o del cliente. Una cadena no vacía; tiene prioridad sobre el User-Agent HTTP.

Parámetros de respuesta

  • Instrucción aceptada
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "A giant robot dinosaur suddenly appears",
        "accepted": true
    }
}
code integerCódigo de retorno. 0 indica éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

encryptedTravelId stringEl ID de viaje cifrado.content stringEl texto de instrucción aceptado.accepted booleanIndica si la instrucción ha sido aceptada y ha entrado en el flujo de procesamiento.

Estados previos y notas de llamada

  • Solo creationModel=simple admite este endpoint; un Viaje scriptlist debe usar Actualización completa del guion, y llamar a instruct por error devuelve 403006.
  • El estado actual del Viaje debe poder recibir instrucciones; un Viaje que ha finalizado o fallado no permite escritura.
  • Cuando content está vacío o supera los 2000 caracteres, se devuelve 400000.
  • Recomendamos generar un clientRequestId estable para cada instrucción lógica y reutilizarlo en los reintentos.
  • Cuando la instrucción no cumple con la política de seguridad de contenido, se devuelve 403004.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos

Después de enviar la instrucción: