> **Documentation Index:** Fetch the complete configuration index at https://help.smelter.ai/en/llms.txt

# Projects

GET 
```xml
https://api.smelter.ai/v2/projects
```

Returns list of projects along with their settings. The response example:

```py
{
   "data":[
      {
          "title":"My Brand Name",
          "channel_name":"abcdef",
          "query_params":{
              "channel_keywords_include":["keyword one", "keyword two"],
              "channel_keywords_exclude":["something to exclude"],
              "channel_languages": ["eng"],
              "channel_source_names": ["myhost.com"]
           }
       },
       {
          "title":"My Second Brand Name",
          "channel_name":"bcdfg",
          "query_params":{
              "channel_keywords_include":["second brand",
              "channel_keywords_exclude":[],
              "channel_languages": ["esp"],
              "channel_source_names": ["myhost2.com"]
           }
       }, ...
    ]
}
```
       
GET 
```xml
https://api.smelter.ai/v2/projects/<project_name>
```

Returns settings for single project. The response example:

```py
{
   "data":
      {
          "title":"My Brand Name",
          "channel_name":"abcdef",
          "query_params":{
              "channel_keywords_include":["keyword one", "keyword two"],
              "channel_keywords_exclude":["something to exclude"],
              "channel_languages": ["eng"],
              "channel_source_names": ["myhost.com"]
           }
       }
}
```

The data is the same as in the previous endpoint that lists all the projects along with their settings.

PUT 
```xml
https://api.smelter.ai/v2/projects/<project_name>
```

The content should have the following format. All fields must be specified otherwise they can be lost.
The recommended scenario for updating project settings is to get current settings using `GET`, do the changes and `PUT` whole settings. The response example:

```py
          "title":"My Brand Name",
          "channel_name":"abcdef",
          "query_params":{
              "channel_keywords_include":["keyword one", "keyword two"],
              "channel_keywords_exclude":["something to exclude"],
              "channel_languages": ["eng"],
              "channel_source_names": ["myhost.com"]
           }
```

If everyting is ok, returns the `200` code contains new project settings.

DELETE 
```xml
https://api.smelter.ai/v2/projects/<project_name>
```

Returns the `204` code with no content.

POST 
```xml
https://api.smelter.ai/v2/create_project
```

Accepts the content in the format:

```py
{
   "title":"Your Channel Title",
   "query_params": {
       "channel_keywords_include":["first keyword","second keyword"]
   }
}
```

When project is created it responses with the `200` code contains settings of the project.

<a href="../contacts">
  <span class="button">Contacts</span>
</a>