> For the complete documentation index, see [llms.txt](https://docs.openreview.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openreview.net/~/changes/kVYMUwjISEF9x7H1lfSE/getting-started/using-the-api/notes/posting-a-test-submission.md). # Posting a Test Submission If you are testing your venue on the dev site, you may want to generate some test submissions. This can be accomplished manually through the UI, but it may be faster to do it with python using the guide below. ## Venues using API V1 1. If you have not already, you will need to create a username and password on the dev site: [dev.openreview.net/signup](https://dev.openreview.net/signup). Note that sending emails through the dev site is not supported. Therefore, you will need to request the activation link at . 2. Instantiate the python client using your dev profile credentials: ```python import openreview client = openreview.Client( baseurl='https://devapi.openreview.net', username=, password= ) ``` 3. Familiarize yourself with the submission invitation. Every content field of your note will need to be in the format specified by the submission invitation, and any fields marked as "required" will need to be present in the note. 4. Create your note. If you were submitting a note through the [default submission form](/~/changes/kVYMUwjISEF9x7H1lfSE/reference/default-forms/default-submission-form.md#api-v1-json), it would look something like this: ```python note = openreview.Note( invitation = "Test/Venue/-/Submission", readers = [ "Test/Venue", "~Test_Author1", "~Test_Author2" ], writers = [ "Test/Venue", "~Test_Author1", "~Test_Author2" ], signatures = ["~PC_Id1"], content = { "title": { "value": "Test Submission 1" }, "authors": { "value": [ "~Test_Author1", "~Test_Author2" ] }, "authorids": { "value": [ "~Test_Author1", "~Test_Author2" ] }, "keywords": { "value": [ "machine learning", "autonomous vehicles" ] }, "TL;DR": { "value": "A test submission" }, "abstract": { "value": "This is a test submission for my test venue on the dev site." } } ) url = client.put_attachment('./paper.pdf', 'Test/Venue/-/Submission', 'pdf') note.content['pdf'] = { 'value': url } ``` \ **Invitation**: The ID of your venue's submission invitation. It will take the form of your venue id + /-/Submission. \ \ **Readers/Writers**: A list of the venue ID + all author profile IDs. After the submission deadline, these values will be automatically updated to match the visibility settings selected in the venue request form. \ \ **Signatures**: Your profile ID. \ \ **Content**: The actual content of the submission, which must match the invitation. If the invitation calls for any file uploads, such as a pdf or zip file, you can build the url to the file using put\_attachment and entering the path, the invitation ID, and the name of the field. You can then add that field to the note's content. \ The "authorids" field of the note's content should contain a list of the authors' profile IDs or emails, in the same order as the authors' names. If you registered dummy users, you can find their profile IDs by going to their profile page and copying the ID parameter of that page's url. For example, dev.openreview\.net/profile?id=\~Test\_Author2 --> \~Test\_Author2.
5. Post your note and output the resulting note's ID: ```python note = client.post_note_edit(note) print(note.id) ``` You can now view your note in the UI by going to dev.openreview\.net/forum?id=\. ## Venues using API V2 * If you have not already, you will need to create a username and password on the dev site: [dev.openreview.net/signup](https://dev.openreview.net/signup). Note that sending emails through the dev site is not supported. Therefore, you will need to request the activation link at . * Instantiate the python client using your dev profile credentials: ```python import openreview client = openreview.api.Client( baseurl='https://devapi2.openreview.net', username=, password= ) ``` * Familiarize yourself with the submission invitation. Every content field of your note will need to be in the format specified by the submission invitation, and all the fields that do not contain `optional: true` are mandatory. * Create your note. If you were submitting a note through the [default submission form](/~/changes/kVYMUwjISEF9x7H1lfSE/reference/default-forms/default-submission-form.md#api-v2-json), it would look something like this: ```python note = openreview.Note( readers = [ "Test/Venue", "~Test_Author1", "~Test_Author2" ], writers = [ "Test/Venue", "~Test_Author1", "~Test_Author2" ], signatures = ["~PC_Id1"], content = { "title": "Test Submission 1", "authors": [ "~Test_Author1", "~Test_Author2" ], "authorids": [ "~Test_Author1", "~Test_Author2" ], "keywords": [ "machine learning", "autonomous vehicles" ], "TL;DR": "A test submission", "abstract": "This is a test submission for my test venue on the dev site.", } ) url = client.put_attachment('./paper.pdf', 'Test/Venue/-/Submission', 'pdf') note.content['pdf'] = url ``` \ **Invitation**: The ID of your venue's submission invitation. It will take the form of your venue id + /-/Submission. \ \ **Readers/Writers**: A list of the venue ID + all author profile IDs. After the submission deadline, these values will be automatically updated to match the visibility settings selected in the venue request form. \ \ **Signatures**: Your profile ID. \ \ **Content**: The actual content of the submission, which must match the invitation. If the invitation calls for any file uploads, such as a pdf or zip file, you can build the url to the file using put\_attachment and entering the path, the invitation ID, and the name of the field. You can then add that field to the note's content. \ The "authorids" field of the note's content should contain a list of the authors' profile IDs or emails, in the same order as the authors' names. If you registered dummy users, you can find their profile IDs by going to their profile page and copying the ID parameter of that page's url. For example, dev.openreview\.net/profile?id=\~Test\_Author2 --> \~Test\_Author2.
* Post your note and output the resulting note's ID: ```python note = client.post_note_edit( invitation="Test/Venue/-/Submission", signatures="~Test_User1", readers=[ "Test/Venue", "~Test_Author1", "~Test_Author2" ], writers = [ "Test/Venue", "~Test_Author1", "~Test_Author2" ], note=note ) print(note.id) ``` You can now view your note in the UI by going to dev.openreview\.net/forum?id=\. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.openreview.net/~/changes/kVYMUwjISEF9x7H1lfSE/getting-started/using-the-api/notes/posting-a-test-submission.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.