Skip to main content

Referencia de la API HappyOyster-Acting-Send Process Instruction

Envíe una única instrucción de texto a un viaje Acting para impulsar el juego de roles posterior y la generación de fotogramas. Se puede llamar cuando el viaje está en ejecución o en pausa.

Ámbito

Envíe una única instrucción de texto a un viaje Acting para impulsar el juego de roles posterior y la generación de fotogramas. 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.
  • Prerequisites: El estado del viaje debe ser running o paused. Confírmelo mediante Query Travel Status.
  • 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-acting/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-acting/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "Smile and greet me, and ask how my day is going",
    "clientRequestId": "instruction_greeting_001",
    "userAgent": "HappyOyster-Web/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 Acting a controlar. Devuelto por Enter Travel.
content string (Obligatorio)La instrucción de proceso de texto. No vacía, hasta 2000 caracteres; devuelve 400000 cuando falta, está vacía o supera el límite.
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": "Smile and greet me, and ask how my day is going",
        "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

  • El estado del viaje debe ser running o paused.
  • content es obligatorio y no puede estar vacío ni contener solo caracteres de espacio en blanco, hasta un máximo de 2000 caracteres.
  • Enviar una instrucción en el estado paused solo acepta la instrucción y no reanuda automáticamente el viaje; cuando necesite continuar la ejecución, el cliente debe llamar por separado a Resume Travel.
  • Reutilice el clientRequestId al reintentar la misma instrucción lógica para evitar facturación duplicada.
  • Un viaje que ha finalizado o fallado no permite escritura.
  • Cuando la instrucción no cumple con la política de seguridad de contenido, se devuelve 403004.
  • El creationModel de Acting siempre es simple, por lo que no es necesario considerar el submodo ScriptList.

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: