Autenticação

Crie uma chave da Direct API no Studio, escolha seus escopos e limites de créditos, e envie-a em cada solicitação.

Cada solicitação carrega uma chave de API da organização como token bearer.

Authorization: Bearer mor_live_9f2c…

Uma chave pertence à organização, e não à pessoa que a criou. Todos os administradores da organização podem vê-la e revogá-la, e ela continua funcionando quando quem a criou sai da equipe. Ela deixa de funcionar quando é revogada, quando expira, quando a conta de quem a criou é suspensa ou quando a Morphic desativa a Direct API para a organização.

Criar uma chave

Os escopos da Direct API só aparecem depois que a Morphic ativa a Direct API para a sua organização. Veja Como obter acesso.

  1. No Morphic Studio, abra o menu suspenso da organização (o logotipo da Morphic, no canto superior esquerdo) e selecione Configurações.
  2. Na barra lateral esquerda, clique em Chaves de API. Apenas administradores veem essa aba.
  3. Clique em Nova chave.
  4. Preencha o Nome, escolha as Permissões de que a chave precisa e, se ela não deve durar para sempre, quando ela Expira.
  5. Em Limites de créditos, defina o total que a chave poderá gastar em toda a sua vida útil e, opcionalmente, um limite diário e um mensal.
  6. Marque Concordo com os Termos de Uso da Morphic, incluindo a seção da API para desenvolvedores. Isso aceita os Termos de Uso em nome da organização.
  7. Clique em Criar chave e copie o segredo para o seu gerenciador de segredos. Ele é exibido uma única vez.

Qualquer pessoa que tenha o segredo pode gastar os créditos da sua organização até os limites da chave. Nunca coloque uma chave em um navegador, em um app móvel ou em um repositório público.

Formato da chave

mor_live_<64 hex characters>

O prefixo indica a você, e aos scanners de segredos, para qual ambiente a chave foi criada.

Escopos

Uma chave só alcança as ferramentas que seus escopos permitem. Escolha o conjunto mais restrito possível.

EscopoRótulo no StudioConcede
projects:readLer projetos e seus arquivoslistar projetos, workflows e linhas do tempo do Compose
assets:readBuscar e ler recursoslistar a biblioteca, ler gerações e seu status, personagens
assets:writeEnviar recursos e editá-lospassar mídia por URL, criar linhas do tempo do Compose
generations:writeGerar imagens, vídeo e áudio (consome créditos)todas as ferramentas que iniciam, editam ou analisam mídia

Uma chamada a uma ferramenta fora dos escopos da chave responde 403 insufficient_scope e indica o escopo que falta em data.required_scopes. Endpoints e ferramentas que não exigem escopo, como list_voices e /me, ficam abertos a todas as chaves. O catálogo de ferramentas lista o escopo de que cada ferramenta precisa.

Limites de créditos

Toda chave tem tetos de gasto, definidos quando ela é criada. Um administrador pode alterá-los depois com Editar limites.

LimiteObrigatórioPeríodo
total_credit_limitsimtoda a vida útil da chave
monthly_credit_limitnãomês do calendário, UTC
daily_credit_limitnãodia do calendário, UTC
  • Uma chamada paga que levaria a chave além de qualquer limite é recusada com 402 api_key_credit_limit_reached antes de qualquer coisa começar; data.period indica qual limite.
  • O saldo da própria organização também se aplica: uma chamada que ela não consegue pagar é recusada com 402 insufficient_credits.
  • GET /v1/direct/me retorna os limites da chave e o gasto atual. Veja Créditos e uso.

Rotacionar uma chave

  1. Crie a nova chave.
  2. Implante-a.
  3. Revogue a chave antiga com Revogar chave.

Uma organização pode ter até 10 chaves ativas, então a rotação nunca precisa de uma interrupção.


Se você tiver algum problema ou alguma dúvida, entre em contato. Teremos prazer em ajudar. Escreva para nós em support@morphic.com.

Nesta página