Skip to main content

Referência da API HappyOyster-Directing-Send Process Instruction

Envie uma única instrução de texto para uma Viagem no modo padrão para impulsionar a geração subsequente de quadros. Apenas creationModel=simple é suportado; uma Viagem scriptlist deve usar a atualização completa do script.

Escopo

Envie uma única instrução de texto para uma Viagem no modo padrão (creationModel=simple) para impulsionar a geração subsequente de quadros. Antes de chamar, confirme o seguinte:
  • Autenticação: A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-la. Para saber como obtê-las, veja Obter credenciais de autenticação.
  • Pré-requisitos: O creationModel da Viagem deve ser simple, e ela deve estar em um estado capaz de receber instruções. Confirme via Consultar Status da Viagem.
  • Chamador: Tanto seu servidor quanto seu cliente podem fazer a chamada.

Solicitação HTTP

  • Singapore
  • EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/instructSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Enviar instrução de processo
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(Obrigatório)Tipo de conteúdo da solicitação. Este parâmetro deve ser definido como application/json.
Authorization string (Obrigatório)Autenticação por Chave de API. A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-lo.
  • API Key Primária: começa com sk-, ex. sk-xxx.
  • Chave de API Temporária: começa com st-, por exemplo, st-xxx.
Corpo da solicitação
encryptedTravelId string (Obrigatório)O ID de Viagem criptografado de Direção a ser controlado; creationModel deve ser simple. Retornado por Entrar na Viagem.
content string (Obrigatório)A instrução de processo de texto. Não vazia, até 2000 caracteres; retorna 400000 quando vazia ou com mais de 2000 caracteres.
clientRequestId string (Opcional)Chave de idempotência para novas tentativas de instrução. Reutilize o mesmo valor ao tentar novamente a mesma instrução para evitar cobrança duplicada. Formato recomendado [A-Za-z0-9_-]{1,32}.
  • Ser omitido ou malformado não retorna um erro de parâmetro: o servidor recorre ao request_id do gateway e usa uma chave de idempotência aleatória quando isso ainda estiver indisponível
  • Este campo é usado apenas para deduplicação de cobrança; ele não garante que o processamento da instrução em si seja executado exatamente uma vez
userAgent string (Opcional)Identificador de versão do SDK ou cliente. Uma string não vazia; tem precedência sobre o User-Agent HTTP.

Parâmetros de resposta

  • Instrução aceita
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "A giant robot dinosaur suddenly appears",
        "accepted": true
    }
}
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro.
message stringMensagem de erro. null em caso de sucesso.
data objectDados da resposta. null em caso de falha.

Propriedades

encryptedTravelId stringO Travel ID criptografado.content stringO texto da instrução aceita.accepted booleanSe a instrução foi aceita e entrou no fluxo de processamento.

Estados pré-requisitos e notas de chamada

  • Apenas creationModel=simple suporta este endpoint; uma Viagem scriptlist deve usar Atualização Completa do Script, e chamar instruct por engano retorna 403006.
  • O estado atual da Viagem deve ser capaz de receber instruções; uma Viagem que terminou ou falhou não é gravável.
  • Quando content está vazio ou tem mais de 2000 caracteres, 400000 é retornado.
  • Recomendamos gerar um clientRequestId estável para cada instrução lógica e reutilizá-lo em novas tentativas.
  • Quando a instrução falha na política de segurança de conteúdo, 403004 é retornado.

Códigos de erro

Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.

Próximos passos

Após enviar a instrução: