> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.aventure.vc/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.aventure.vc/_mcp/server.

# Answer a natural-language platform help question

POST https://api.aventure.vc/v1/agents/help
Content-Type: application/json

Retrieves the most relevant operations, skills, and completion gates, then returns a grounded, citation-bearing answer. Unsupported questions abstain (LOW confidence) rather than invent a command.

Reference: https://docs.aventure.vc/api-reference/a-venture-api/agent-help/answer-agent-help-question

## Authentication

- `Authorization` header (bearer token, required) — User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key
- `X-API-Key` header (required) — Admin API key for system-to-system write operations
- `X-Client-Secret` header (required) — Client secret for read-only service-to-service access (no writes)

## Request

### Body (application/json)

- `question` (string, required) — The question to answer, in natural language.
- `model` (string, optional, nullable) — Optional chat model that answers the question; null uses the configured default. A CLIENT_SECRET (non-admin) caller may only choose a client-secret-eligible model (owned by app.inference.client-secret-eligible-chat-model); an ineligible model is rejected with 422. Admin keys are unrestricted.
- `scope` (enum, optional, nullable) — Optional scope restricting which operations the answer may recommend; null means all.
  - Allowed values: `READ`, `WRITE`, `ALL`

## Response

### 200

OK

- `answer` (string, required) — Answer drawn only from the cited corpus; abstains when unsupported.
- `citation` (list of object, required) — Corpus evidence backing the answer; empty when the model abstains.
  - `excerpt` (string, required) — Verbatim excerpt from the cited document supporting the answer.
  - `sourceId` (string, required) — Stable id within the source type: an operationId, a skill/prompt name, or a completion gate id.
  - `sourceType` (enum, required) — Which part of the platform corpus this citation comes from.
    - Allowed values: `OPERATION`, `SKILL`, `PROMPT`, `COMPLETION_GATE`
  - `sourceVersion` (string, optional, nullable) — Immutable version of the cited document when one exists (skill/prompt content version); null for catalog-derived sources.
- `confidence` (enum, required) — Confidence the answer is fully supported by the cited corpus. LOW signals an abstention.
  - Allowed values: `HIGH`, `MEDIUM`, `LOW`
- `recommendedCommand` (string, optional, nullable) — Canonical CLI/MCP/API command the asker should run, when one is supported by the cited corpus; null when no single command applies or the model abstains.

## Examples

**Request**

```json
{
  "question": "how do I attach a product URL?"
}
```

**Response**

```json
{
  "answer": "string",
  "citation": [
    {
      "excerpt": "string",
      "sourceId": "createEntityText",
      "sourceType": "OPERATION",
      "sourceVersion": "string"
    }
  ],
  "confidence": "HIGH",
  "recommendedCommand": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.aventure.vc/v1/agents/help"

payload = { "question": "how do I attach a product URL?" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.aventure.vc/v1/agents/help';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"question":"how do I attach a product URL?"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aventure.vc/v1/agents/help"

	payload := strings.NewReader("{\n  \"question\": \"how do I attach a product URL?\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.aventure.vc/v1/agents/help")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"question\": \"how do I attach a product URL?\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.aventure.vc/v1/agents/help")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"question\": \"how do I attach a product URL?\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.aventure.vc/v1/agents/help', [
  'body' => '{
  "question": "how do I attach a product URL?"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.aventure.vc/v1/agents/help");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"question\": \"how do I attach a product URL?\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["question": "how do I attach a product URL?"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.aventure.vc/v1/agents/help")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```