Project

https://boomstream.com/api/project

Для использования с AI / LLM

↗Открыть Markdown

Методы: create | info | list | update | delete

create

Создание нового проекта

Входные параметры

Обязательные параметры:

String email (Email вашей учетной записи Boomstream)
String title (Название проекта)
String apikey (API ключ вашего проекта)

Выходные параметры

String ApiKey (API ключ созданного проекта)
String Title (Название созданного проекта)
String Code (Код созданного проекта)

Пример запроса:

https://boomstream.com/api/app/create?email=[EMAIL]&title=[TITLE]&apikey=[API_KEY]

Пример ответа:

<Response>
    <ApiKey>xxx...xxx</ApiKey>
    <Code>TeRwmuvi</Code>
    <Title>title</Title>
    <Message>Application is successfully created</Message>
    <Status>Success</Status>
</Response>

info

Информация о проекте

Входные параметры

Обязательные параметры:

String apikey (API ключ вашего проекта)
String email (Email вашей учетной записи Boomstream; должен соответствовать аккаунту, которому принадлежит apikey)

Выходные параметры

String Title (Название проекта)
String apikey (API ключ вашего проекта)
String Code (Код вашего проекта)

Пример запроса:

https://boomstream.com/api/app/info?apikey=[API_KEY]&email=[EMAIL]

Пример ответа:

<Response>
    <Message>Application info</Message>
    <Title>Updated by API</Title>
    <ApiKey>xxx...xxx</ApiKey>
    <Code>TeRwmuvi</Code>
    <Status>Success</Status>
</Response>

list

Список проектов

Входные параметры

Обязательные параметры:

String email (Email вашей учетной записи Boomstream)
String apikey (API ключ вашего проекта)

Пример запроса:

https://boomstream.com/api/app/list?email=[EMAIL]&apikey=[API_KEY]

Пример ответа:

<Response>
    <Items>
        <Item>
            <ApiKey>xxx...xxx</ApiKey>
            <Title>Updated by API</Title>
            <Code>OPkmGnkl</Code>
        </Item>
        <Item>
            <ApiKey>xxx...xxx</ApiKey>
            <Title>v2</Title>
            <Code>TeRwmuvi</Code>
        </Item>
    </Items>
    <Status>Success</Status>
</Response>

update

Изменение названия проекта

Входные параметры

Обязательные параметры:

String apikey (API ключ проекта)
String email (Email вашей учетной записи Boomstream; должен соответствовать аккаунту, которому принадлежит apikey)
String title (Название проекта)

Выходные параметры

String ApiKey (API ключ проекта)
String Title (Название проекта)
String Code (Код вашего проекта)

Пример запроса:

https://boomstream.com/api/app/update?apikey=[API_KEY]&email=[EMAIL]&title=[TITLE]

Пример ответа:

<Response>
    <Message>Application is successfully updated</Message>
    <Title>newTestTitle</Title>
    <ApiKey>xxx...xxx</ApiKey>
    <Code>TeRwmuvi</Code>
    <Status>Success</Status>
</Response>

delete

Удаление проекта

Примечание: Вся информация о проекте будет удалена: медиафайлы, папки, подписки, а затем и сам проект.

Входные параметры

Обязательные параметры:

String apikey (API ключ проекта пользователя)
String apikey_delete (API ключ проекта для удаления)
String email (Email вашей учетной записи Boomstream; должен соответствовать аккаунту, которому принадлежит apikey)

Пример запроса:

https://boomstream.com/api/app/delete?apikey=[API_KEY]&apikey_delete=[API_KEY]&email=[EMAIL]

Пример ответа:

<Response>
    <Message>Application is successfully deleted</Message>
    <Status>Success</Status>
</Response>