# List or Add Publication Collaborators by Custom URL

POST /api/v1/publications/publication/collaborators/
Content-Type: application/json

Hybrid POST endpoint operating on publication identified by custom URL (resolved via mixin).
Behavior: If request JSON omits 'email', returns collaborator list. If 'email' is provided, attempts to add collaborator using same validation rules as ID-based endpoint.
Permissions: Access controlled by PublicationAccessControlMixin (workspace/public visibility ACL).
Errors: 404 for missing publication/user or insufficient authority; 400 for role validation failures.

Reference: https://docs.aisquare.studio/api-reference/ai-square-studio-api/publications/publication-collaborators-create

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v1/publications/publication/collaborators/:
    post:
      operationId: publication-collaborators-create
      summary: List or Add Publication Collaborators by Custom URL
      description: >-
        Hybrid POST endpoint operating on publication identified by custom URL
        (resolved via mixin).

        Behavior: If request JSON omits 'email', returns collaborator list. If
        'email' is provided, attempts to add collaborator using same validation
        rules as ID-based endpoint.

        Permissions: Access controlled by PublicationAccessControlMixin
        (workspace/public visibility ACL).

        Errors: 404 for missing publication/user or insufficient authority; 400
        for role validation failures.
      tags:
        - subpackage_publications
      responses:
        '200':
          description: >-
            List of collaborators or publication collaborator data after no-op
            listing.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/publications_publicationCollaboratorsCreate_Response_200
        '400':
          description: Validation error (e.g., user not eligible)
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Publication or user not found / insufficient permission
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: >-
                    Custom publication URL used for lookup (required even when
                    listing).
                email:
                  type: string
                  format: email
                  description: >-
                    Optional email to add as collaborator. If omitted, lists
                    collaborators.
              required:
                - url
components:
  schemas:
    publications_publicationCollaboratorsCreate_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: publications_publicationCollaboratorsCreate_Response_200

```

## SDK Code Examples

```python
import requests

url = "https://api.example.com/api/v1/publications/publication/collaborators/"

payload = { "url": "my-publication.aisquare" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/publications/publication/collaborators/';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"url":"my-publication.aisquare"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/publications/publication/collaborators/"

	payload := strings.NewReader("{\n  \"url\": \"my-publication.aisquare\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/publications/publication/collaborators/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"my-publication.aisquare\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/publications/publication/collaborators/")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"my-publication.aisquare\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.example.com/api/v1/publications/publication/collaborators/', [
  'body' => '{
  "url": "my-publication.aisquare"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/publications/publication/collaborators/");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"my-publication.aisquare\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["url": "my-publication.aisquare"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/publications/publication/collaborators/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

```python
import requests

url = "https://api.example.com/api/v1/publications/publication/collaborators/"

payload = { "url": "my-publication.aisquare" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/publications/publication/collaborators/';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"url":"my-publication.aisquare"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/publications/publication/collaborators/"

	payload := strings.NewReader("{\n  \"url\": \"my-publication.aisquare\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/publications/publication/collaborators/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"my-publication.aisquare\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/publications/publication/collaborators/")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"my-publication.aisquare\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.example.com/api/v1/publications/publication/collaborators/', [
  'body' => '{
  "url": "my-publication.aisquare"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/publications/publication/collaborators/");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"my-publication.aisquare\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["url": "my-publication.aisquare"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/publications/publication/collaborators/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```