Docs/API Reference
API Reference
Integrate AI Product Manager with your applications and workflows.
EST. READ TIME: 5 MIN
Authentication
All API requests require authentication using an API key. Include your API key in the Authorization header.
Authorization: Bearer YOUR_API_KEY
To get your API key, log in to your account, go to Settings → API Keys, and generate a new key.
Base URL
https://api.artificialoutreach.com/v1
All API endpoints are relative to this base URL.
Endpoints
POST /projects
Create a new product planning project.
Request Body:
{
"name": "Project Name",
"description": "Detailed product description",
"target_audience": "Target users",
"key_features": ["Feature 1", "Feature 2"],
"ai_model": "claude"
}
Response (200):
{
"id": "proj_123456",
"name": "Project Name",
"created_at": "2024-11-08T10:30:00Z",
"status": "active"
}
POST /projects/{projectId}/generate/prd
Generate a Product Requirement Document.
Request Body:
{
"detailed_requirements": "Additional requirements",
"include_sections": ["features", "user_stories"],
"ai_model": "claude"
}
Response (200):
{
"id": "prd_123456",
"project_id": "proj_123456",
"content": "PRD markdown content...",
"generated_at": "2024-11-08T10:35:00Z"
}
POST /projects/{projectId}/generate/tasks
Generate development tasks.
Request Body:
{
"scope": "full",
"include_estimates": true,
"format": "json"
}
Response (200):
{
"id": "tasks_123456",
"project_id": "proj_123456",
"tasks": [
{
"id": "task_001",
"title": "Task Title",
"description": "...",
"acceptance_criteria": ["..."],
"estimated_points": 5
}
],
"total_tasks": 45,
"generated_at": "2024-11-08T10:45:00Z"
}
Rate Limits
Basic
100 requests/hour
Teams
500 requests/hour
Enterprise
Unlimited
Error Codes
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
403Forbidden - Insufficient permissions
404Not Found - Resource does not exist
429Too Many Requests - Rate limit exceeded
500Server Error - Temporary issue
Code Example
import requests
api_key = "your_api_key"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
# Create project
response = requests.post(
"https://api.artificialoutreach.com/v1/projects",
headers=headers,
json={
"name": "My Product",
"description": "...",
"ai_model": "claude"
}
)
project_id = response.json()["id"]
# Generate PRD
response = requests.post(
f"https://api.artificialoutreach.com/v1/projects/{project_id}/generate/prd",
headers=headers,
json={}
)
print(response.json())
Support
For API-specific questions, contact our developer support team at api-support@artificialoutreach.com