whoami
Who this connection belongs to
Returns the account this connection acts in (an artist's, or a label's with its roster), what this connection is allowed to do, where the result is reviewed, and next_steps: what to offer the artist next, worked out from the account. Call this first, and again whenever you are unsure whose catalog you are working in. On a label connection, pass `artist` to see one roster artist's account.
输入参数artist
get_requirements
What Audora needs
Every field Audora needs, with its exact limit in characters or words, the closed list to choose from where there is one, and the accepted file formats and sizes. Call this BEFORE filling anything in. The limits differ per field: some are refused when exceeded and some only flagged. What blocks a release is set by Audora, and it changes.
输入参数entityrelease_type
design_in_audora
Open Audora's design tools
Audora can design a logo, cover art, brand colors and typefaces, artist photos, and promotion posts and short videos for the artist. Those are made inside Audora, not through this connection: call this to get the exact page to send the artist to, with a sentence on what they will find there. Use it whenever the artist wants a logo, artwork, a cover, visuals, photos or promo video made.
输入参数what必填artistalbum_idtrack_id
get_stats
How the music is doing
Streams, saves and growth per track, which stores and playlists the listening comes from, TikTok use, the audience's age and gender, how the artist's promotion posts performed, and their followers. For the whole catalog, when the artist has connected their own Songstats account, it also gives their numbers across the web (listeners, followers, playlist reach, socials, Shazam, charts), the cities they are listened to in now, the playlists carrying them and dated events. The same numbers the artist sees in Audora. Use it to answer "how is my release doing", to write a pitch or bio from real numbers, or to suggest where to focus next. When a figure is missing, say "not reported yet", never zero.
输入参数artistalbum_idtrack_id
get_limits
What this account's plan allows
The plan, whether distribution is included, credits remaining, and the track, album and storage allowances. Check before uploading or preparing a submission.
输入参数artist
get_profile
The artist's profile
The artist profile as Audora holds it.
输入参数artist
report_gap
Tell Audora what you could not do
Call this whenever the artist asks for something there is no tool for, or a tool refuses in a way you cannot work around. It files the ask in Audora's support inbox, where a person reads it, and it shows in the artist's Settings › Support. Call it before you tell the artist no. It changes nothing in their catalog, and it is the only way the ask reaches anyone.
输入参数noteasked_for必填tool_tried
send_feedback
Tell Audora how it could serve the artist better
Send Audora feedback it will read, as one of these kinds. missing_capability: a change you would need to do what the artist wants. connector_improvement: how this connector could work better for an assistant, such as a confusing tool, a missing field or a result that did not tell you enough. product_improvement: how Audora itself could serve artists better. bug: something that looks broken. other: anything else. It goes into Audora's support inbox and shows in the artist's Settings › Support, so write it for a person: what you were trying to do, what got in the way and what would have helped. Use it when you notice something worth fixing. You do not need the artist's permission, but set artist_asked to true when the artist asked for it. For a plain "there is no tool for that", report_gap is enough.
输入参数kind必填tooldetails必填summary必填artist_asked
list_tracks
Tracks in the catalog
Every track in this account, newest first.
输入参数artist
get_track
One track in full
One track with its billed artists and its song credits.
输入参数artisttrack_id必填
list_albums
Albums in the catalog
Every album in this account, newest first.
输入参数artist
check_readiness
What is still missing
For one track or one album: everything Audora still needs before that release could be submitted, and anything worth a second look that does not block it. That includes the stores' intake rules, checked against the uploaded master and cover themselves (a stereo WAV, FLAC or Apple Lossless master at a rate the stores take; square RGB JPG 3000–6000 px). Call this after writing, and again before telling the artist something is ready.
输入参数artistalbum_idtrack_id
find_online
Look the artist up online
Runs Audora's own lookup of what the artist has already published (streaming profiles, releases, their site and social profiles), or reads where one is and what it found. Use it only when you cannot search the web yourself: otherwise look the artist up with your own search, check with them that you found the right artist, and fill their page with update_profile. With action "start" it begins one, which takes 1–2 minutes; the artist gets a few a day, shared with Soundcheck in Audora. The account's first lookup is free and each later one costs credits and needs the artist's spend permission: start with dry_run: true to read the price, tell the artist, then start with confirm_cost_credits. With action "status" (the default) it reads the newest lookup, or the one named by run_id. Every fact comes with the pages it was read on. It never changes the artist's profile: when it is done, call propose_profile so the artist keeps what is theirs in Audora.
输入参数linkactionartistnot_merun_iddry_runconfirm_cost_credits
propose_profile
Put what was found in front of the artist
Puts a finished find_online lookup in front of the artist in Audora and returns the link to it. The artist confirms it is them and keeps what is right there. This call writes nothing to their profile, and you should not copy the findings into update_profile yourself. Their Home says their assistant found something to look at.
输入参数artistrun_id
update_profile
Fill in the artist's profile
Set artist details: name, country, genre, tone, description, main markets, Promo's post language, the three bios and links. Send only the fields you are changing. Call get_requirements first for the exact limits. An over-long value is refused with the number it got.
输入参数artistfields必填dry_run
Create a track from its metadata. The audio and the cover art are uploaded separately. Pass idempotency_key if you might retry, so a timeout does not leave two tracks.
输入参数artistfields必填dry_runidempotency_key
update_track
Change a track
Amend a track's metadata. Refused once its release has been submitted: a submitted release carries a frozen copy, and changing the catalog underneath it is the artist's own decision, because it costs credits.
输入参数artistfields必填dry_runtrack_id必填
set_track_credits
Credit who made a track
Replace a track's song credits with this list. Every track needs at least one songwriter, one performer and one producer before its release can be submitted. These are real people: ask the artist, and never invent a name to satisfy the requirement.
输入参数artistcredits必填dry_runtrack_id必填
set_track_artists
Set who a track is billed to
Replace the OTHER artists a track is billed to: the "Artist & Guest feat. Guest" line on every store. The account's own artist is always billed first and cannot be removed. Do not send it (a name equal to it is dropped, never printed twice). Send the others in billing order. `primary` and `with` join the main credit after the account's artist; `featured` and `remixer` become the "feat." part. Another `primary` artist is a collaboration: ask the artist whether they have all the rights needed for it, and send rights_confirmed: true only when they say yes. Without it the call is refused and nothing is written. `featured`, `with` and `remixer` need no confirmation. Optional: a track with none is billed to the artist profile's own name. The songwriter, performer and producer credits are a different list, set with set_track_credits.
输入参数artistartists必填dry_runtrack_id必填rights_confirmed
Create an album or EP. Put tracks on it afterward with set_album_tracks.
输入参数artistfields必填dry_runidempotency_key
update_album
Change an album
Amend an album's details. Refused once its release has been submitted.
输入参数artistfields必填dry_runalbum_id必填
set_album_tracks
Set an album's running order
Put these tracks on this album, in this order. Replaces whatever was on it. A track left out is taken off the album, not deleted.
输入参数artistdry_runalbum_id必填track_ids必填
request_upload
Get somewhere to put a file
Ask for a one-time address to upload a master, cover art, a logo or an artist photo to. You need the file's NAME, nothing else. Never ask the artist how big a file is. PUT the file to the address you get back, then call finalize_upload, which reads the file itself and checks the size, the format and the account's storage against it.
输入参数kind必填bytesartistalbum_idfilename必填track_idmime_type
finalize_upload
Check an uploaded file and attach it
Audora reads the file you uploaded (the file itself, not its name) and attaches it only if it meets the upload spec. A master that is secretly an MP3, or a cover that is not square or is under 3000 pixels, is refused here and the file is removed. Passing here is not the same as being releasable: a release also needs a stereo master and a square RGB JPG cover of 3000–6000 px, which check_readiness reports on.
输入参数nameartistupload_id必填
save_release_draft
Prepare a release, as a draft
Write the release details for a track or album as a DRAFT. A draft costs nothing, can be changed and goes nowhere until the artist says so. Returns a draft_hash identifying exactly what you prepared, and release_rules: everything the track or album still needs to meet the stores' rules (master format, cover, sub-genre, languages, countries, performer roles) before it can be submitted. An older track or album usually needs some of it. A draft saves even when it is unfinished: a release date sooner than the stores take is saved and comes back in `warnings`, and submitting refuses it until it is changed.
输入参数type必填artistitem_id必填release
get_release_questions
What Audora has asked the artist
Questions Audora's reviewers asked about the artist's releases (for example, whether the rights to a remix are cleared), with the whole conversation. A release with an unanswered question does not go out until the artist answers. Omit release_id for every open question.
输入参数artistrelease_id
answer_release_question
Send the artist's answer to Audora
Send the ARTIST'S answer to a question Audora asked about their release (see get_release_questions). Ask the artist and relay what they say. Never answer for them and never guess: an answer can be a statement about rights or ownership that Audora relies on. Audora is told it came through their assistant. The release status does not change; Audora reads the answer and moves the release on.
输入参数answer必填artistdry_runrelease_id必填idempotency_key
list_releases
Releases and their status
Every release in this account with where it has reached (status_label: Draft, Submitted, Changes asked, Going to the stores, Ready for release day, Live, Rejected, Takedown asked, Taken down, Released elsewhere), including anything Audora asked about.
输入参数artist
list_campaigns
Promo campaigns
Every Promo campaign in this account, with its window, whether it is ahead, running or over, and how many posts are to look at, scheduled, posted or did not go out. A release's campaign is kind release; between releases a campaign is a month (kind between_releases), and none starts by itself: start_campaign with between_releases plans the next one. Also lists upcoming releases that have no campaign yet, and campaigns being planned right now.
输入参数artist
get_campaign
A campaign's calendar
One campaign as Promo's calendar: every post by day and lane, with its words, hashtags, picture or video, status, and schedule_check: exactly what Audora's Schedule would decide about it now, and in the artist's words what it still needs.
输入参数artistcampaign_id必填
promo_this_week
What is posting this week
What goes out in the next days across every campaign, what in that time is not scheduled yet (and so will not go out unless it is), and what did not go out lately and needs the artist.
输入参数daysartist
promo_results
How the posts did
The posts that went out, best first, with their latest reach, likes, comments, shares, saves and views, the totals over the window, and the followers on each connected account. A missing number is not reported yet, never zero. what_works: per platform, the angles and posting hours that have beaten the artist's usual most often, from their own posts only, with how many posts each rests on.
输入参数dayslimitartist
start_campaign
Start a Promo campaign
Start a campaign for an upcoming release, or a month between releases (between_releases: true, from tomorrow; none starts by itself, so start the next month the same way when one ends). A release already out gets no campaign of its own: its start is made between releases with its song first (the answer says between_releases: true). Audora writes the campaign (every post's day, time, words and what picture or video it needs) at a price that grows with its size (2 a week is the least, Every day the most; the dry run's quote.plan says it), charged when it starts and returned if the plan fails; starting it needs the artist's spend permission. Nothing is made: fill each post from the artist's Library with update_post, or have Audora make one with make_posts (priced then). A campaign is planned in moments: one video or picture posted the same day on every connected account it fits, with words for each account. Each moment costs 1 credit to go out, all its accounts included, only when it is scheduled. The answers about the song (the_story, key_lyrics, key_moments, what_works, sonic_references, note) are the Start panel's: optional, filled from what Audora knows when left out, and they turn on posts that use them. A release (or the time between releases) can run several campaigns at once, each with its own language, lead market and accounts; one that would copy a live campaign in all three is refused (a dry run's quote.duplicate_of names it, quote.live_campaigns lists them). Planned posts fit around the posts other campaigns already have on the same accounts: one video and one picture a day per account. Use dry_run first to see the posts, the price and those answers (quote.answers), tell the artist, then start with confirm_cost_credits.
输入参数notesize必填aboutlanes必填artistdry_runaccountsthe_storykey_lyricsrelease_idwhat_workskey_moments另有 11 个
Change a post's words, hashtags, link, day, time, its picture or video (from the Library), or the angle its words take. Send only what changes. Returns the post with schedule_check: what Schedule would decide now. A post already scheduled can be changed only with the schedule permission; one already handed to its platform's own schedule (Facebook, YouTube) or one that went out cannot be changed here.
输入参数datetimeangleartistcaptiondry_runpost_id必填hashtagslink_urlmedia_asset_ididempotency_key
Bring a skipped post, or one that did not go out, back as a draft to schedule. A draft is already kept.
输入参数artistpost_id必填idempotency_key
Skip a post so it does not go out. It stays on the campaign and keep_post brings it back. Skipping a post that is already scheduled takes it out of the queue and returns its posting credit, and needs the schedule permission.
输入参数artistpost_id必填idempotency_key
Add a post to a campaign on one lane and day, as Promo's + does, with its words, the angle they take and a picture or video from the Library if you have them. It is a post on its own, not part of a moment, and a draft until it is scheduled.
输入参数date必填lane必填timeangleartistcaptiondry_runhashtagslink_urlcampaign_id必填media_asset_ididempotency_key
list_todos
What the artist still needs to do
Every open to-do the artist sees on their pages, most urgent first: what it is, how urgent, where it is fixed and the tool that fixes it from here. Each has a key; closable says whether close_todo can close it.
输入参数artist
Close one to-do the artist does not want to see, exactly as closing it in Audora does: it comes back by itself when what it is about changes. A track's or album's missing details are not closed: they are fixed.
输入参数key必填artistidempotency_key
list_release_todos
A release's checklist
With release_id: the release's "Around the release" checklist (pitch, pre-save, Canvas, lyrics, release day and the weeks after), each with when it is due, why, where it is done and whether it is done. Without: the artist's "Set up once" list (Instagram ready to post, photos and clips for the posts, claiming the store profiles, the bio link).
输入参数artistrelease_id
set_todo_done
Tick a checklist item
Mark one checklist item done, or not done again: the tick in Audora.
输入参数done必填artisttodo_id必填idempotency_key
list_media
The artist's Library
The artist's pictures or videos in Audora's Library, newest first, searchable by name and filterable by category (Brand kit, Logo, Cover art, Promo, a platform, Generated, Uploaded, Stock footage). Each has a media_asset_id (what update_post takes) and a preview link valid for an hour.
输入参数kindlimitartistoffsetsearchcategories
set_first_listen
First listen on release day
Switch a release on or off the list other artists on Audora see on release day, to give it a first listen. Refused for a release out more than four weeks ago or released elsewhere.
输入参数on必填artistrelease_id必填idempotency_key
list_events
The artist's shows and parties
The shows, release parties and listening parties the artist has posted, with who is invited and who is coming, and their drafts (saved, not posted, seen by nobody else). Artist connections only: Scene is between artists.
输入参数artist
save_event
Save or post a show or party
Save the artist's own show, release party or listening party, or change one (pass event_id). It is saved as a DRAFT that only the artist sees, with whatever is known (only kind is needed), unless you pass post: true. Posting puts it on Scene for artists on Audora (and on the public page when is_public) and needs a title, starts_at and a place: a city and a country, and/or an online link. Post only when the artist asked for it to go out. An event already posted stays posted, so its changes need the same. Inviting artists or Audora stays the artist's to do in Audora; an edit keeps what they chose. Artist connections only.
输入参数postevent必填artistevent_ididempotency_key
cancel_event
Cancel a show or party
Cancel one of the artist's events. Everyone invited or coming is told. Artist connections only.
输入参数artistevent_id必填idempotency_key
find_my_music
Find the artist's released music
Find which artist on Deezer (and Apple Music) is this artist, to bring their released records in: the confirmed one, or candidates to show the artist. A link to their music (Deezer, Spotify or Apple, artist or record) searches from that instead of the name.
输入参数linkartist
confirm_my_music
Confirm which music is the artist's
"That's me": record the candidates the ARTIST said are theirs (a catalog can be split across pages). Only ids find_my_music offered. Ask the artist. Never confirm on a guess.
输入参数artistdeezer_ids必填idempotency_key
preview_catalog_import
What can come in
The records of the confirmed artist, newest first and 50 a page, with their codes, date and type, matched against the catalog: new, already in the catalog, or in conflict with another account. total says how many there are in all. Also the plan's room for songs and albums.
输入参数pageartistdeezer_album_ids
import_catalog
Bring the records in
Start bringing the chosen records into the catalog, within the plan's room. Covers come in only when the artist said they are theirs to use (rights_confirmed: true, their own words, recorded as their consent); otherwise every record comes in with its codes and the cover is left to upload.
输入参数items必填artistidempotency_keyrights_confirmed
catalog_import_status
How the import is going
The latest import (or the one named): how many records are in, and each record's outcome.
输入参数artistjob_id