> For the complete documentation index, see [llms.txt](https://docs.delphi.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delphi.ai/api-immortal-only/questions.md).

# Questions

<a href="https://help.delphi.co" class="button primary">Visit the Help Center</a>

### Get questions <a href="#get-questions" id="get-questions"></a>

Retrieve the suggested questions configured for your clone. These are the conversation starters shown on your clone's profile.

**Endpoint:** `GET /v3/questions`

**Query parameters:**

| Parameter   | Type    | Required | Default    | Description                            |
| ----------- | ------- | -------- | ---------- | -------------------------------------- |
| `type`      | string  | No       | `"pinned"` | Filter: `pinned`, `unpinned`, or `all` |
| `count`     | integer | No       | `5`        | Number of questions to return (1–100)  |
| `randomize` | boolean | No       | `false`    | Return questions in random order       |

**Type values:**

| Value      | Description                             |
| ---------- | --------------------------------------- |
| `pinned`   | Visible questions shown on your profile |
| `unpinned` | Backlog questions not currently visible |
| `all`      | Both pinned and unpinned questions      |

**Example request:**

```bash
curl "https://api.delphi.ai/v3/questions?type=pinned&count=3" \
  -H "x-api-key: YOUR_API_KEY"
```

**Example response:**

```json
{
  "questions": [
    {
      "id": "q-001",
      "index": 2,
      "question": "What's your best advice for beginners?",
      "pinned": true,
      "user_edited": false,
      "created_at": "2025-06-01T12:00:00.000Z",
      "updated_at": "2025-06-01T12:00:00.000Z"
    },
    {
      "id": "q-002",
      "index": 1,
      "question": "How did you get started in your career?",
      "pinned": true,
      "user_edited": true,
      "created_at": "2025-05-20T09:00:00.000Z",
      "updated_at": "2025-06-10T14:30:00.000Z"
    }
  ]
}
```

**Response fields:**

| Field         | Type    | Description                                    |
| ------------- | ------- | ---------------------------------------------- |
| `id`          | string  | Question UUID                                  |
| `index`       | integer | Display order index                            |
| `question`    | string  | The question text                              |
| `pinned`      | boolean | Whether the question is visible on the profile |
| `user_edited` | boolean | Whether the question was manually edited       |
| `created_at`  | string  | ISO 8601 timestamp                             |
| `updated_at`  | string  | ISO 8601 timestamp                             |

{% hint style="info" %}
By default, questions are ordered by `index` descending. Use `randomize=true` to shuffle the order.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.delphi.ai/api-immortal-only/questions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.