Skip to content

Commit 83c359e

Browse files
committed
replace old docs with mintlify ready docs
1 parent 5dd50ce commit 83c359e

45 files changed

Lines changed: 1324 additions & 20663 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1 @@
1-
# Website
2-
3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4-
5-
### Installation
6-
7-
```
8-
$ yarn
9-
```
10-
11-
### Local Development
12-
13-
```
14-
$ yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
### Build
20-
21-
```
22-
$ yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
40-
41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
1+
# Captide API

api-reference/endpoint/agent.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Agent Response'
3+
openapi: 'POST /api/v1/rag/agent-query-stream'
4+
---

api-reference/endpoint/chunks.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Chunk Retrieval'
3+
openapi: 'POST /api/v1/rag/chunks'
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Get Companies'
3+
openapi: 'GET /api/v1/companies'
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Get Documents'
3+
openapi: 'GET /api/v1/document'
4+
---

api-reference/introduction.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: 'Introduction'
3+
description: 'API for performing RAG on SEC filings, financial reports, and earnings call data with source linking capabilities.'
4+
---
5+
6+
## API Conventions
7+
- All JSON request and response fields use **camelCase** naming (e.g., `sourceType`, `fiscalPeriod`, `documentId`)
8+
- URL paths follow **kebab-case** convention (e.g., `/api/v1/rag/agent-query-stream`)
9+
- Date format: ISO 8601 (YYYY-MM-DD)
10+
- Authentication: API key via X-API-Key header

0 commit comments

Comments
 (0)