{
  "schema_version": 2,
  "id": "operate/iris/agent-playbook/create-playbook",
  "title": "Create a playbook",
  "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/create-playbook/",
  "summary": "Create an Agent Playbooks playbook in Redis Cloud and give your agents access to it.",
  "tags": [
    "docs",
    "operate",
    "iris"
  ],
  "last_updated": "2026-11-03T08:33:55-08:00",
  "page_type": "content",
  "content_hash": "5bf7f661a5c3badb4ed4a0b315f9560d21d4af8c391e5350309ee2f323d8336d",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "A playbook is a registry of the frequently asked questions (FAQs) and skills your agents can use, with its own access grants and retrieval settings. Agents receive only the versions you publish. This guide walks you through creating a playbook in the Redis Cloud console and giving an agent access to it."
    },
    {
      "id": "before-you-begin",
      "title": "Before you begin",
      "role": "content",
      "text": "The playbook stores its data in a Redis Cloud database. Use one of your databases, or let the console create a free database when you create the playbook. To create one yourself, see [Create a database](https://redis.io/docs/latest/operate/rc/databases/create-database).\n\nAn existing database must be active and have:\n\n- An enabled [default user](https://redis.io/docs/latest/operate/rc/security/access-control/data-access-control/default-user) with a password.\n- A public endpoint that Agent Playbooks can reach.\n- Support for the JavaScript Object Notation (JSON) data type and Redis Query Engine, with Search version 2.10 or later.\n\nThe console lists only databases that meet these requirements.\n\nIf the database has a Classless Inter-Domain Routing (CIDR) allow list that blocks Agent Playbooks, you can't create the playbook with it. The console lists the Internet Protocol (IP) addresses to add. Add them under **Security** in the database's settings."
    },
    {
      "id": "create-a-playbook",
      "title": "Create a playbook",
      "role": "content",
      "text": "1. From the [Redis Cloud console](https://cloud.redis.io/), select **Agent Playbooks** under **Iris** in the menu.\n\n    If you don't have a playbook yet, you see an introduction to Agent Playbooks. Otherwise, you see the list of your playbooks.\n\n    <!-- TODO: screenshot of the Agent Playbooks introduction page. -->\n\n1. Select **New playbook**.\n\n1. In the **New playbook** dialog, enter the following:\n\n    | Setting | Description |\n    |:--------|:------------|\n    | **Name** | A name for the playbook, up to 128 characters. |\n    | **Database** | The Redis Cloud database that stores the playbook's data. The list shows the databases you can use. If you don't have a free database, select **Free Redis database** to create one with the playbook. An existing free database appears first, with a **Free** badge. |\n    | **Embedding model** | The model that creates embeddings for semantic matching. Each option shows its provider and number of dimensions. Models listed as **Redis** use Redis-managed credentials. Models listed as **Bring Your Own** use your provider's application programming interface (API) key. |\n\n    You can't change the database or the embedding model after you create the playbook.\n\n    <!-- TODO: screenshot of the New playbook dialog. -->\n\n1. Select **Create playbook**. Creation can take up to two minutes.\n\n1. In the **Connect to Playbook** step, [create an API key for your agent](#give-an-agent-access), or select **Skip for now**.\n\nThe console opens the playbook's **Configuration** tab. The playbook's status shows **Provisioning** until it's **Ready**. A playbook can also show **Failed**, **Suspended**, **Deleting**, or **Unavailable**."
    },
    {
      "id": "add-your-provider-api-key",
      "title": "Add your provider API key",
      "role": "content",
      "text": "If you chose a **Bring Your Own** embedding model, the playbook needs your provider API key before it can process content. Until you add it, the **Registry** tab asks you to add it in **Configuration**.\n\n1. On the playbook's **Configuration** tab, find the **Embedding provider credential** section.\n1. Enter your **Provider API key**.\n1. Select **Save provider credential**.\n\nThis key is separate from the API key your agents use to read the playbook. You can replace it later from the same section."
    },
    {
      "id": "give-an-agent-access",
      "title": "Give an agent access",
      "role": "content",
      "text": "Agents read a playbook at its endpoint, with an API key that has access to it.\n\n1. On the playbook's page, select **Connect**. The **Connect to Playbook** dialog shows the playbook's **Endpoint** and **Playbook ID**. Copy them for your agent.\n\n    This dialog also opens as the second step when you create a playbook.\n\n1. Select **Create an API key**.\n\n1. Enter a **Key name**, or keep the default.\n\n1. Under **What can this key do?**, choose the actions for this key:\n\n    | Use | Actions |\n    |:----|:--------|\n    | Retrieve published knowledge | `read` |\n    | Retrieve knowledge and submit proposals | `read`, `propose` |\n    | Complete the developer authoring quickstart | `write`, `publish` |\n\n    `write`, `publish`, and `propose` each include `read`. Keep the authoring key separate from the key your agent uses at runtime.\n\n1. Choose an **Expiration**. The default is 90 days.\n\n1. Select **Create API key**.\n\n1. Copy the key, and then select **Done**.\n\n    > [!WARNING]\n    > The console shows the key only once, when you create it. Save it to a secure location before you select **Done**.\n\nTo set more options, select **Customize in the full page** in the **Create API key** step. The console opens **Access & Identity** with this playbook selected.\n\nFor what each action allows, see [Playbooks](https://redis.io/docs/latest/develop/ai/context-engine/agent-playbooks/concepts#playbooks).\n\nTo replace an expiring key, create another key with the same grants, update your application's connection settings, and verify a request before removing the old key. Manage existing keys in **Access & Identity**. Deleting a key removes its access after cached authorization expires; it does not withdraw or delete playbook entries.\n\nIf **Create an API key** is unavailable, ask your account administrator for permission to manage keys for this playbook. An authoring or publishing grant does not grant permission to administer API keys.\n\nIf provisioning fails or the playbook does not become **Ready**, follow [Troubleshoot a playbook](https://redis.io/docs/latest/operate/iris/agent-playbook/manage-playbook#troubleshoot-a-playbook) before continuing."
    },
    {
      "id": "next-steps",
      "title": "Next steps",
      "role": "content",
      "text": "- [Publish and retrieve your first FAQ](https://redis.io/docs/latest/develop/ai/context-engine/agent-playbooks/quickstart).\n- [View and manage the playbook](https://redis.io/docs/latest/operate/iris/agent-playbook/manage-playbook): add FAQs and skills, publish versions, test retrieval, and review proposals."
    }
  ],
  "examples": []
}