Skip to main content
POST
/
projects
Create Project
curl --request POST \
  --url https://api.teleskop.dev/projects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Turkish Airlines",
  "languages": [
    "tr",
    "en"
  ],
  "channels": [
    "news",
    "twitter"
  ],
  "keywords": [
    {
      "main_keyword": "Turkish Airlines",
      "required_keywords": [
        "Istanbul Airport"
      ],
      "excluded_keywords": [
        "Sabiha Gökçen"
      ],
      "id": "c167d51e-7249-4430-a13e-043eab185b58"
    }
  ],
  "members_ids": []
}
'
{
  "status": "success",
  "statusCode": 200,
  "data": {
    "name": "Turkish Airlines",
    "languages": [
      "tr",
      "en"
    ],
    "channels": [
      "news",
      "twitter"
    ],
    "keywords": [
      {
        "main_keyword": "Turkish Airlines",
        "required_keywords": [
          "Istanbul Airport"
        ],
        "excluded_keywords": [
          "Sabiha Gökçen"
        ],
        "id": "c167d51e-7249-4430-a13e-043eab185b58"
      }
    ],
    "id": "c0bb3b48-60eb-4afe-a229-3207e7ad800a",
    "keywords_count": 1,
    "creator_id": "a76ea981-f007-44e6-b4d7-2dbdc61ce338",
    "workspace_id": "2cca4ace-63a0-41f0-a73f-0b8abe2909a5",
    "workspace_name": "My Organization",
    "created_at": "2025-07-29T13:37:12.547Z",
    "updated_at": "2025-07-29T13:37:12.547Z",
    "members_ids": []
  },
  "message": "Request successful",
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.teleskop.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Body

application/json
​
name
string
required

Display name of the project

Example:

"Turkish Airlines"

​
languages
string[]
required

Selected languages for this project

Example:
["tr", "en"]
​
channels
string[]
required

Selected channels for this project

Example:
["news", "twitter"]
​
keywords
object[]
required

Array of keyword objects, each containing main_keyword, required_keywords, and excluded_keywords.

​
members_ids
string[]

Response

201 - application/json

Project created successfully

​
status
enum<string>
required

Response status

Available options:
success,
error
Example:

"success"

​
statusCode
number
required

HTTP status code

Example:

200

​
data
object
required

Response data

​
message
string
required

Response message

Example:

"Request successful"

​
metadata
object

Additional metadata