Skip to content
Docs
Open Escouade
Documentation contents

Docs › Mail › Tools

create_key

View as .md

Create an agent’s key.

Creates the API key of one of the space’s agents (a script, another assistant, an automation). It is returned once only, in this response. It holds send and read by default, never approve: an agent does not approve its own sends. It can be limited to some inboxes and to a number of messages per day. A key is never written in an e-mail.

Access

  • Key: an Escouade Mail key with approve.
  • Space: a verified space.
  • Changes nothing: no, it acts.
  • Safe to replay: use an idempotency_key where the tool offers one.

Parameters

ParameterTypeRequiredDescription
namestringyesName of the agent, for example “agent-devis”.
permissionslist of stringnoAbsent: send and read.
inbox_idslist of stringnoThe only inboxes open to the key. Absent: all of them, present and future.
daily_capintegernoCap on messages created per day. Absent: none.

Call it

Terminal
curl -s https://api.subagent.fr/v1/create_key \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sak_…' \
  -d '{"name": "…"}'

The full page in French, with the response fields and every refusal the tool can return: /mail/docs/reference/create_key.

This page in Markdown: /en/mail/docs/reference/create_key.md All the docs for an agent: /en/mail/docs/llms.txt Legal notice · Terms · Privacy · Service status