> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Nooks in Deepline

> Inspect Nooks workspace data through documented read actions. Write actions remain unavailable until Deepline can validate them in an internal test workspace.

[Human guide: work with your agent →](https://deepline.com/docs/human/providers/nooks/guide.md)
Inspect one Nooks action before starting provider-backed work. Your first result is a verified input and output contract.

## Provider-specific requirements

Use Nooks to inspect a connected customer's sales-engagement workspace.

* The internal test endpoint uses hidden `nooks_get_me` to verify the
  credential and identify the connected workspace.
* Use list actions to find IDs, then fetch a specific sequence, prospect,
  account, task, call, mailbox, user, sequence state, step, disposition, or
  email template.
* Keep pagination bounded. Nooks supports cursor pagination with `page[size]`
  up to 100 and `page[after]` or `page[before]`.
* Use at most three comma-separated top-level `include` values. Nested includes
  are not supported.
* All mutations are unavailable until Deepline can validate them in an internal
  test workspace. `nooks_create_sequence_state` has the additional risk that it
  can trigger immediate enrichment and consume workspace entitlements.
  Email reads remain unavailable until complete provider-owned response
  evidence is available.
* Do not use the deferred `call.logged` webhook as a polling or monitor
  substitute.

## Find an applicable action

Confirm your effective workspace, then search the live catalog:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline auth status --json
deepline search "Nooks" --type tools --json
```

Search returns candidates. Check the returned provider and operation rather than selecting a similar title automatically.

## Inspect the selected contract

Replace `<returned-tool-id>` with the identifier returned by discovery:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe <returned-tool-id> --json
```

These commands do not execute the selected provider action. Read its required inputs, supported access mode, pricing unit, outputs, and limits.

A connection does not establish that every action supports BYOK. Follow the provider-specific requirements above and the live action contract.

## Prepare one reviewed input

Use one authorized record that matches the inspected schema. Preserve its source identity and define the result you will accept.

Open the action reference for its payload and response shape. Provider-backed execution can incur usage or external effects.

For reusable logic, follow [Write Plays](https://deepline.com/docs/sdk-v2/plays.md). For direct-call recovery, use [Tool execution recovery](https://deepline.com/docs/sdk-v2/tool-execution-recovery.md).

> [!TIP]
>
> Continue only when the workspace, provider, required fields, acceptance rule, and applicable price are understood. Keep unavailable access separate from no-result evidence.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.