V2 Files

Base URL: https://api.codefundi.app. Path repo_id: UUID or percent-encoded URL.

GET `/v2/files/{repo_id}`

Summary: Paginated file list with documentation hints. Credits: 1 credit / request.

Query parameters

Parameter	Type	Description
`limit`	int	Page size 1–100, default 20.
`offset`	int	Offset.
`order_by`	string	Default `file_path`.
`order`	enum	`asc` \| `desc`.
`search`	string	Match `file_name` or `file_path`.

Response: paginated file items (id, file_name, file_path, description, dependencies, total_lines, and related fields).

cURL

files-list.sh


curl -sS -G "https://api.codefundi.app/v2/files/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "limit=50" \
  --data-urlencode "order_by=file_path" \
  --data-urlencode "order=asc"

JavaScript


const  = 'https://api.codefundi.app'
const  = '550e8400-e29b-41d4-a716-446655440000'
 
const  = `${}/v2/files/${}?${new ({
  : '50',
  : 'file_path',
  : 'asc'
})}`
 
const 
const res: Responseres = await (, { : { 'X-API-Key': 'YOUR_API_KEY' } })

Python

files_list.py


import urllib.parse
import urllib.request
 
repo_id = "550e8400-e29b-41d4-a716-446655440000"
q = urllib.parse.urlencode(
    {"limit": "50", "order_by": "file_path", "order": "asc"}
)
req = urllib.request.Request(
    f"https://api.codefundi.app/v2/files/{repo_id}?{q}",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
with urllib.request.urlopen(req) as resp:
    print(resp.read().decode())

GET `/v2/files/{repo_id}/{file_id}`

Summary: Markdown documentation for one file.

Path: file_id may be a UUID or a URL-encoded file_path.

Query: `fields`

Value	Notes
`basic`	Lightweight fields.
`summary`	Mid depth.
`full`	Default; rich documentation.

Credits: 2 credits / file when documentation is ready. If the file is still processing, the response indicates processing and is not charged.

Check meta.processing, meta.fields_applied, and meta.credits_used on success.

cURL

file-doc.sh


curl -sS "https://api.codefundi.app/v2/files/550e8400-e29b-41d4-a716-446655440000/660e8400-e29b-41d4-a716-446655440001?fields=full" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript


const  = 'https://api.codefundi.app'
const  = '550e8400-e29b-41d4-a716-446655440000'
const  = '660e8400-e29b-41d4-a716-446655440001'
 
type  = 'basic' | 'summary' | 'full'
 
function (: string, : string, : ): string {
  return `${}/v2/files/${}/${}?${new ({  })}`
}
 
const  = (, , 'full')
const 
const res: Responseres = await (, { : { 'X-API-Key': 'YOUR_API_KEY' } })

Python

file_doc.py


import urllib.request
 
repo_id = "550e8400-e29b-41d4-a716-446655440000"
file_id = "660e8400-e29b-41d4-a716-446655440001"
req = urllib.request.Request(
    f"https://api.codefundi.app/v2/files/{repo_id}/{file_id}?fields=full",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
with urllib.request.urlopen(req) as resp:
    print(resp.read().decode())

V2 Files

GET /v2/files/{repo_id}

Query parameters

cURL

JavaScript

Python

GET /v2/files/{repo_id}/{file_id}

Query: fields

cURL

JavaScript

Python

GET `/v2/files/{repo_id}`

GET `/v2/files/{repo_id}/{file_id}`

Query: `fields`