Skip to content

Commit ce17ca1

Browse files
docs: Add 'Listing All Conversations' section with search endpoint
Documents the search endpoint with correct response format: - Returns 'items' array (not 'results') - Shows pagination with next_page_id Co-authored-by: openhands <openhands@all-hands.dev>
1 parent 50332cf commit ce17ca1

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

openhands/usage/cloud/cloud-api.mdx

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,58 @@ while True:
333333
time.sleep(30)
334334
```
335335

336+
### Listing All Conversations
337+
338+
To list all your conversations, use the search endpoint:
339+
340+
<Tabs>
341+
<Tab title="cURL">
342+
```bash
343+
curl -X GET "https://app.all-hands.dev/api/v1/app-conversations/search?limit=20" \
344+
-H "Authorization: Bearer YOUR_API_KEY"
345+
```
346+
</Tab>
347+
<Tab title="Python (with requests)">
348+
```python
349+
import requests
350+
351+
api_key = "YOUR_API_KEY"
352+
headers = {"Authorization": f"Bearer {api_key}"}
353+
354+
response = requests.get(
355+
"https://app.all-hands.dev/api/v1/app-conversations/search",
356+
headers=headers,
357+
params={"limit": 20}
358+
)
359+
result = response.json()
360+
361+
for conv in result.get("items", []):
362+
print(f"ID: {conv['id']}, Status: {conv.get('execution_status')}")
363+
```
364+
</Tab>
365+
</Tabs>
366+
367+
**Response:**
368+
```json
369+
{
370+
"items": [
371+
{
372+
"id": "660e8400-e29b-41d4-a716-446655440001",
373+
"sandbox_status": "RUNNING",
374+
"execution_status": "finished",
375+
"selected_repository": "yourusername/your-repo",
376+
"title": "Fix README"
377+
}
378+
],
379+
"next_page_id": null
380+
}
381+
```
382+
383+
<Note>
384+
The search endpoint returns conversations in the `items` array. Use `next_page_id`
385+
for pagination if you have more conversations than the `limit`.
386+
</Note>
387+
336388
## Rate Limits
337389

338390
If you have too many conversations running at once, older conversations will be paused to limit the number of concurrent conversations.

0 commit comments

Comments
 (0)