{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"35666e2f-7d3b-4e06-8871-8eed9cf121ae","name":"Chirpy","description":"# Chirpy API Documentation\n\n## Overview\n\nChirpy is a social media API that allows users to create and manage short messages called \"chirps\". The API provides endpoints for user management, chirp operations, health monitoring, and administrative functions.\n\n## Base URL\n\nAll API endpoints use the following base URL pattern:\n\n```\n{{baseURL}}\n\n ```\n\nSet the `baseURL` variable in your Postman environment to point to your Chirpy server instance.\n\n## Authentication\n\nAuthentication requirements vary by endpoint:\n\n- **Public endpoints**: No authentication required (health check, app root)\n    \n- **User endpoints**: Require user authentication token\n    \n- **Admin endpoints**: Require administrative privileges\n    \n\nInclude authentication tokens in the `Authorization` header:\n\n```\nAuthorization: Bearer <your_token>\n\n ```\n\n## API Endpoints\n\n### App\n\n#### GET /app\n\n**Root endpoint** - Returns the application root page or status.\n\n**Endpoint**: `{{baseURL}}/app`\n\n**Method**: `GET`\n\n**Authentication**: None required\n\n---\n\n### Users\n\nUser management endpoints for registration and authentication.\n\n#### POST /api/users\n\n**Create User** - Register a new user account.\n\n**Endpoint**: `{{baseURL}}/api/users`\n\n**Method**: `POST`\n\n**Authentication**: None required\n\n**Request Body**:\n\n``` json\n{\n  \"email\": \"user@example.com\",\n  \"password\": \"securepassword\"\n}\n\n ```\n\n**Response**: Returns the created user object with user ID and details.\n\n---\n\n#### POST /api/login\n\n**Login User** - Authenticate a user and receive an access token.\n\n**Endpoint**: `{{baseURL}}/api/login`\n\n**Method**: `POST`\n\n**Authentication**: None required\n\n**Request Body**:\n\n``` json\n{\n  \"email\": \"user@example.com\",\n  \"password\": \"securepassword\"\n}\n\n ```\n\n**Response**: Returns authentication token and user information.\n\n---\n\n### Chirps\n\nEndpoints for creating and retrieving chirps (short messages).\n\n#### POST /api/chirps\n\n**Create Chirp** - Post a new chirp message.\n\n**Endpoint**: `{{baseURL}}/api/chirps`\n\n**Method**: `POST`\n\n**Authentication**: Required (Bearer token)\n\n**Request Body**:\n\n``` json\n{\n  \"body\": \"This is my chirp message\"\n}\n\n ```\n\n**Response**: Returns the created chirp with ID, timestamp, and content.\n\n---\n\n#### GET /api/chirps\n\n**Get All Chirps** - Retrieve all chirps from all users.\n\n**Endpoint**: `{{baseURL}}/api/chirps`\n\n**Method**: `GET`\n\n**Authentication**: None required\n\n**Query Parameters**:\n\n- `sort` (optional): Sort order for chirps (e.g., `asc`, `desc`)\n    \n\n**Response**: Returns an array of chirp objects.\n\n---\n\n#### GET /api/chirps/:chirpID\n\n**Get Chirp by ID** - Retrieve a specific chirp by its ID.\n\n**Endpoint**: `{{baseURL}}/api/chirps/:chirpID`\n\n**Method**: `GET`\n\n**Authentication**: None required\n\n**Path Parameters**:\n\n- `chirpID` (required): The unique identifier of the chirp\n    \n\n**Response**: Returns the requested chirp object.\n\n---\n\n#### GET /api/users/:userID/chirps\n\n**Get Chirps by User ID** - Retrieve all chirps from a specific user.\n\n**Endpoint**: `{{baseURL}}/api/users/{{userID}}/chirps`\n\n**Method**: `GET`\n\n**Authentication**: None required\n\n**Path Parameters**:\n\n- `userID` (required): The unique identifier of the user\n    \n\n**Response**: Returns an array of chirps created by the specified user.\n\n---\n\n#### GET /api/me/chirps\n\n**Get My Chirps** - Retrieve all chirps from the authenticated user.\n\n**Endpoint**: `{{baseURL}}/api/me/chirps`\n\n**Method**: `GET`\n\n**Authentication**: Required (Bearer token)\n\n**Response**: Returns an array of chirps created by the authenticated user.\n\n---\n\n### Health\n\n#### GET /api/healthz\n\n**Health Check** - Check the health status of the API.\n\n**Endpoint**: `{{baseURL}}/api/healthz`\n\n**Method**: `GET`\n\n**Authentication**: None required\n\n**Response**: Returns the health status of the service (typically `200 OK`).\n\n---\n\n### Admin\n\nAdministrative endpoints for monitoring and maintenance.\n\n#### GET /admin/metrics\n\n**Metrics** - Retrieve application metrics and statistics.\n\n**Endpoint**: `{{baseURL}}/admin/metrics`\n\n**Method**: `GET`\n\n**Authentication**: Required (Admin privileges)\n\n**Response**: Returns metrics data including request counts, performance statistics, and system health.\n\n---\n\n#### POST /admin/reset\n\n**Reset** - Reset the application state (typically used in development/testing).\n\n**Endpoint**: `{{baseURL}}/admin/reset`\n\n**Method**: `POST`\n\n**Authentication**: Required (Admin privileges)\n\n**Response**: Confirms the reset operation.\n\n---\n\n## Error Handling\n\nThe API uses standard HTTP status codes:\n\n- **200 OK**: Request succeeded\n    \n- **201 Created**: Resource created successfully\n    \n- **400 Bad Request**: Invalid request parameters or body\n    \n- **401 Unauthorized**: Authentication required or failed\n    \n- **403 Forbidden**: Insufficient permissions\n    \n- **404 Not Found**: Resource not found\n    \n- **500 Internal Server Error**: Server error\n    \n\nError responses include a JSON body with details:\n\n``` json\n{\n  \"error\": \"Error message describing what went wrong\"\n}\n\n ```\n\n## Rate Limiting\n\nRate limiting policies may apply to prevent abuse. Check response headers for rate limit information:\n\n- `X-RateLimit-Limit`: Maximum requests allowed\n    \n- `X-RateLimit-Remaining`: Remaining requests in current window\n    \n- `X-RateLimit-Reset`: Time when the rate limit resets\n    \n\n## Getting Started\n\n1. **Set up your environment**: Create a Postman environment and set the `baseURL` variable to your Chirpy server URL\n    \n2. **Create a user**: Use the `POST /api/users` endpoint to register\n    \n3. **Login**: Use the `POST /api/login` endpoint to get your authentication token\n    \n4. **Save your token**: Store the token in an environment variable for authenticated requests\n    \n5. **Start chirping**: Use the authenticated endpoints to create and manage chirps\n    \n\n## Support\n\nFor issues, questions, or feature requests, please contact the development team or refer to the project repository.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"46941071","team":8955456,"collectionId":"35666e2f-7d3b-4e06-8871-8eed9cf121ae","publishedId":"2sBXc8qizy","public":true,"publicUrl":"https://documenter-api.postman.tech/view/46941071/2sBXc8qizy","privateUrl":"https://go.postman.co/documentation/46941071-35666e2f-7d3b-4e06-8871-8eed9cf121ae","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2026-02-08T19:15:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/fcf3dc8802bac9cfdc2be2cc2fb95135f36d3e302741491321f07663f53de2a0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXc8qizy"}